Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

 

# -*- coding: utf-8 -*- 

 

u'''Functions to parse and format bearing, compass, lat- and longitudes 

in various forms of degrees, minutes and seconds. 

 

After I{(C) Chris Veness 2011-2015} published under the same MIT Licence**, see 

U{Latitude/Longitude<https://www.Movable-Type.co.UK/scripts/latlong.html>} and 

U{Vector-based geodesy<https://www.Movable-Type.co.UK/scripts/latlong-vectors.html>}. 

 

@newfield example: Example, Examples 

''' 

 

from pygeodesy.basics import issequence, isstr, map2 

from pygeodesy.errors import ParseError, _parseX, RangeError, \ 

_rangerrors, _ValueError 

from pygeodesy.interns import _COMMA_, _NE_, _NSEW_, _NW_, _SE_ # PYCHOK used! 

from pygeodesy.interns import NN, _deg_, _degrees_, _DOT_, _E_, \ 

_EW_, joined, _N_, _NS_, _PLUS_, \ 

_radians_, _S_, _SPACE_, _SW_, _W_, \ 

_0_, _0_5, _60_0, _360_0, _3600_0 

from pygeodesy.lazily import _ALL_LAZY 

from pygeodesy.streprs import fstr, fstrzs 

 

from math import copysign, modf, radians 

try: 

from string import letters as _LETTERS 

except ImportError: # Python 3+ 

from string import ascii_letters as _LETTERS 

 

__all__ = _ALL_LAZY.dms 

__version__ = '20.10.08' 

 

F_D = 'd' # unsigned format "deg°" plus suffix 

F_DM = 'dm' # unsigned format "deg°min′" plus suffix 

F_DMS = 'dms' # unsigned format "deg°min′sec″" plus suffix 

F_DEG = _deg_ # unsigned format "[D]DD" plus suffix without symbol 

F_MIN = 'min' # unsigned format "[D]DDMM" plus suffix without symbols 

F_SEC = 'sec' # unsigned format "[D]DDMMSS" plus suffix without symbols 

F__E = 'e' # unsigned format "%E" plus suffix without symbol 

F__F = 'f' # unsigned format "%F" plus suffix without symbol 

F__G = 'g' # unsigned format "%G" plus suffix without symbol 

F_RAD = 'rad' # convert degrees to radians and format unsigned "RR" plus suffix 

 

F_D_ = '-d' # signed format "-/deg°" without suffix 

F_DM_ = '-dm' # signed format "-/deg°min′" without suffix 

F_DMS_ = '-dms' # signed format "-/deg°min′sec″" without suffix 

F_DEG_ = '-deg' # signed format "-/[D]DD" without suffix and symbol 

F_MIN_ = '-min' # signed format "-/[D]DDMM" without suffix and symbols 

F_SEC_ = '-sec' # signed format "-/[D]DDMMSS" without suffix and symbols 

F__E_ = '-e' # signed format "-%E" without suffix and symbol 

F__F_ = '-f' # signed format "-%F" without suffix and symbol 

F__G_ = '-g' # signed format "-%G" without suffix and symbol 

F_RAD_ = '-rad' # convert degrees to radians and format as signed "-/RR" without suffix 

 

F_D__ = '+d' # signed format "-/+deg°" without suffix 

F_DM__ = '+dm' # signed format "-/+deg°min′" without suffix 

F_DMS__ = '+dms' # signed format "-/+deg°min′sec″" without suffix 

F_DEG__ = '+deg' # signed format "-/+[D]DD" without suffix and symbol 

F_MIN__ = '+min' # signed format "-/+[D]DDMM" without suffix and symbols 

F_SEC__ = '+sec' # signed format "-/+[D]DDMMSS" without suffix and symbols 

F__E__ = '+e' # signed format "-/+%E" without suffix and symbol 

F__F__ = '+f' # signed format "-/+%F" without suffix and symbol 

F__G__ = '+g' # signed format "-/+%G" without suffix and symbol 

F_RAD__ = '+rad' # convert degrees to radians and format signed "-/+RR" without suffix 

 

S_DEG = '°' # degrees "°" symbol 

S_MIN = '′' # minutes "′" symbol 

S_SEC = '″' # seconds "″" symbol 

S_RAD = NN # radians symbol "" 

S_SEP = NN # separator between deg, min and sec "" 

S_NUL = NN # empty string 

 

_F_case = {F_D: F_D, F_DEG: F_D, _degrees_: F_D, 

F_DM: F_DM, F_MIN: F_DM, 'deg+min': F_DM, 

F__E: F__E, F__F: F__F, F__G: F__G, 

F_RAD: F_RAD, _radians_: F_RAD} 

 

_F_prec = {F_D: 6, F_DM: 4, F_DMS: 2, # default precs 

F_DEG: 6, F_MIN: 4, F_SEC: 2, 

F__E: 8, F__F: 8, F__G: 8, F_RAD: 5} 

 

_F_symb = {F_DEG, F_MIN, F_SEC, F__E, F__F, F__G} # set({}) pychok -Tb 

 

_S_norm = {'^': S_DEG, '˚': S_DEG, # normalized DMS 

"'": S_MIN, '’': S_MIN, '′': S_MIN, 

'"': S_SEC, '″': S_SEC, '”': S_SEC} 

_S_ALL = (S_DEG, S_MIN, S_SEC) + tuple(_S_norm.keys()) # alternates 

 

_MINUS_ = '-' 

_MINUS_PLUS_ = _MINUS_ + _PLUS_ 

 

 

def _0wpF(*w_p_f): 

'''(INTERNAL) Float deg, min, sec formatter'. 

''' 

return '%0*.*F' % w_p_f 

 

 

def _toDMS(deg, form, prec, sep, ddd, suff): # MCCABE 15 by .units.py 

'''(INTERNAL) Convert degrees to C{str}, with/-out sign and/or suffix. 

''' 

try: 

deg = float(deg) 

except (TypeError, ValueError) as x: 

raise _ValueError(deg=deg, txt=str(x)) 

 

form = form.lower() 

sign = form[:1] 

if sign in _MINUS_PLUS_: 

form = form[1:] 

else: 

sign = S_NUL 

 

if prec is None: 

z = p = _F_prec.get(form, 6) 

else: 

z = int(prec) 

p = abs(z) 

w = p + (1 if p else 0) 

d = abs(deg) 

 

if form in _F_symb: 

s_deg = s_min = s_sec = S_NUL # no symbols 

else: 

s_deg, s_min, s_sec = S_DEG, S_MIN, S_SEC 

 

F = _F_case.get(form, F_DMS) 

if F is F_DMS: # 'deg+min+sec' 

d, s = divmod(round(d * _3600_0, p), _3600_0) 

m, s = divmod(s, _60_0) 

t = joined(_0wpF(ddd, 0, d), s_deg, sep, 

_0wpF( 2, 0, m), s_min, sep, 

_0wpF(w+2, p, s)) 

s = s_sec 

 

elif F is F_DM: # 'deg+min' 

d, m = divmod(round(d * _60_0, p), _60_0) 

t = joined(_0wpF(ddd, 0, d), s_deg, sep, 

_0wpF(w+2, p, m)) 

s = s_min 

 

elif F is F_D: # 'deg' 

t = _0wpF(ddd+w, p, d) 

s = s_deg 

 

elif F is F_RAD: 

t = '%.*F' % (p, radians(d)) 

s = S_RAD 

 

else: # F in (F__E, F__F, F__G) 

t = ('%.*' + F) % (p, d) 

s = S_NUL 

 

if z > 1: 

t = fstrzs(t, ap1z=F is F__G) 

 

if sign: 

if deg < 0: 

t = _MINUS_ + t 

elif deg > 0 and sign == _PLUS_: 

t = _PLUS_ + t 

elif suff: # and deg: # zero suffix? 

s += sep + suff 

return t + s 

 

 

def bearingDMS(bearing, form=F_D, prec=None, sep=S_SEP): 

'''Convert bearing to a string. 

 

@arg bearing: Bearing from North (compass C{degrees360}). 

@kwarg form: Optional B{C{bearing}} format (C{str} or L{F_D}, 

L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, 

L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, 

L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, 

L{F_SEC_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, 

L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, 

L{F_MIN__}, L{F_SEC__}, L{F__E__}, L{F__F__}, 

L{F__G__} or L{F_RAD__}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

@kwarg sep: Optional separator (C{str}). 

 

@return: Compass degrees per the specified B{C{form}} (C{str}). 

 

@JSname: I{toBrng}. 

''' 

return _toDMS(bearing % _360_0, form, prec, sep, 1, NN) 

 

 

def _clipped_(angle, limit, units): 

'''(INTERNAL) Helper for C{clipDegrees} and C{clipRadians}. 

''' 

c = min(limit, max(-limit, angle)) 

if c != angle and _rangerrors: 

t = '%s beyond %s %s' % (fstr(angle, prec=6, ints=True), 

copysign(limit, angle), units) 

raise RangeError(t, txt=None) 

return c 

 

 

def clipDegrees(deg, limit): 

'''Clip a lat- or longitude to the given range. 

 

@arg deg: Unclipped lat- or longitude (C{degrees}). 

@arg limit: Valid B{C{-limit..+limit}} range (C{degrees}). 

 

@return: Clipped value (C{degrees}). 

 

@raise RangeError: If B{C{abs(deg)}} beyond B{C{limit}} and 

L{rangerrors} set to C{True}. 

''' 

return _clipped_(deg, limit, _degrees_) if limit and limit > 0 else deg 

 

 

def clipRadians(rad, limit): 

'''Clip a lat- or longitude to the given range. 

 

@arg rad: Unclipped lat- or longitude (C{radians}). 

@arg limit: Valid B{C{-limit..+limit}} range (C{radians}). 

 

@return: Clipped value (C{radians}). 

 

@raise RangeError: If B{C{abs(rad)}} beyond B{C{limit}} and 

L{rangerrors} set to C{True}. 

''' 

return _clipped_(rad, limit, _radians_) if limit and limit > 0 else rad 

 

 

def compassDMS(bearing, form=F_D, prec=None, sep=S_SEP): 

'''Convert bearing to a string suffixed with compass point. 

 

@arg bearing: Bearing from North (compass C{degrees360}). 

@kwarg form: Optional B{C{bearing}} format (C{str} or L{F_D}, 

L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, 

L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, 

L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, 

L{F_SEC_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, 

L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, 

L{F_MIN__}, L{F_SEC__}, L{F__E__}, L{F__F__}, 

L{F__G__} or L{F_RAD__}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

@kwarg sep: Optional separator (C{str}). 

 

@return: Compass degrees and point in the specified form (C{str}). 

''' 

return _toDMS(bearing % _360_0, form, prec, sep, 1, compassPoint(bearing)) 

 

 

def compassPoint(bearing, prec=3): 

'''Convert bearing to a compass point. 

 

@arg bearing: Bearing from North (compass C{degrees360}). 

@kwarg prec: Optional precision (1 for cardinal or basic winds, 

2 for intercardinal or ordinal or principal winds, 

3 for secondary-intercardinal or half-winds or 

4 for quarter-winds). 

 

@return: Compass point (1-, 2-, 3- or 4-letter C{str}). 

 

@raise ValueError: Invalid B{C{prec}}. 

 

@see: U{Dms.compassPoint 

<https://GitHub.com/chrisveness/geodesy/blob/master/dms.js>} 

and U{Compass rose<https://WikiPedia.org/wiki/Compass_rose>}. 

 

@example: 

 

>>> p = compassPoint(24, 1) # 'N' 

>>> p = compassPoint(24, 2) # 'NE' 

>>> p = compassPoint(24, 3) # 'NNE' 

>>> p = compassPoint(24) # 'NNE' 

>>> p = compassPoint(11, 4) # 'NbE' 

>>> p = compassPoint(30, 4) # 'NEbN' 

 

>>> p = compassPoint(11.249) # 'N' 

>>> p = compassPoint(11.25) # 'NNE' 

>>> p = compassPoint(-11.25) # 'N' 

>>> p = compassPoint(348.749) # 'NNW' 

''' 

try: # m = 2 << prec; x = 32 // m 

m, x = _MOD_X[prec] 

except KeyError: 

raise _ValueError(prec=prec) 

# not round(), i.e. half-even rounding in Python 3, 

# but round-away-from-zero as int(b + 0.5) iff b is 

# non-negative, otherwise int(b + copysign(0.5, b)) 

q = int((bearing % _360_0) * m / _360_0 + _0_5) % m 

return _WINDS[q * x] 

 

 

_MOD_X = {1: (4, 8), 2: (8, 4), 3: (16, 2), 4: (32, 1)} # [prec] 

_WINDS = (_N_, 'NbE', 'NNE', 'NEbN', _NE_, 'NEbE', 'ENE', 'EbN', 

_E_, 'EbS', 'ESE', 'SEbE', _SE_, 'SEbS', 'SSE', 'SbE', 

_S_, 'SbW', 'SSW', 'SWbS', _SW_, 'SWbW', 'WSW', 'WbS', 

_W_, 'WbN', 'WNW', 'NWbW', _NW_, 'NWbN', 'NNW', 'NbW') # cardinals 

 

 

def degDMS(deg, prec=6, s_D=S_DEG, s_M=S_MIN, s_S=S_SEC, neg=_MINUS_, pos=NN): 

'''Convert degrees to a string in degrees, minutes B{I{or}} seconds. 

 

@arg deg: Value in degrees (C{scalar}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

@kwarg s_D: Symbol for degrees (C{str}). 

@kwarg s_M: Symbol for minutes (C{str}) or C{""}. 

@kwarg s_S: Symbol for seconds (C{str}) or C{""}. 

@kwarg neg: Optional sign for negative (C{'-'}). 

@kwarg pos: Optional sign for positive (C{''}). 

 

@return: I{Either} degrees, minutes B{I{or}} seconds (C{str}). 

''' 

try: 

deg = float(deg) 

except (TypeError, ValueError) as x: 

raise _ValueError(deg=deg, txt=str(x)) 

 

d, s = abs(deg), s_D 

if d < 1: 

if s_M: 

d *= _60_0 

if d < 1 and s_S: 

d *= _60_0 

s = s_S 

else: 

s = s_M 

elif s_S: 

d *= 3600 

s = s_S 

 

n = neg if deg < 0 else pos 

z = int(prec) 

t = '%s%.*F' % (n, abs(z),d) 

if z > 1: 

t = fstrzs(t) 

return t + s 

 

 

def latDMS(deg, form=F_DMS, prec=2, sep=S_SEP): 

'''Convert latitude to a string, optionally suffixed with N or S. 

 

@arg deg: Latitude to be formatted (C{degrees}). 

@kwarg form: Optional B{C{deg}} format (C{str} or L{F_D}, 

L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, 

L{F__E}, L{F__F}, L{F__G}, L{F_D_}, L{F_RAD}, 

L{F_D_}, L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_} 

L{F_SEC_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, 

L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, 

L{F_MIN__}, L{F_SEC__}, L{F__E__}, L{F__F__}, 

L{F__G__} or L{F_RAD__}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

@kwarg sep: Optional separator (C{str}). 

 

@return: Degrees in the specified form (C{str}). 

 

@JSname: I{toLat}. 

''' 

return _toDMS(deg, form, prec, sep, 2, _S_ if deg < 0 else _N_) 

 

 

def latlonDMS(lls, form=F_DMS, prec=None, sep=None): 

'''Convert one or more C{LatLon} instances to strings. 

 

@arg lls: Single or a list, sequence, tuple, etc. (C{LatLon}s). 

@kwarg form: Optional B{C{deg}} format (C{str} or L{F_D}, 

L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, 

L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, 

L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, 

L{F_SEC_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, 

L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, 

L{F_MIN__}, L{F_SEC__}, L{F__E__}, L{F__F__}, 

L{F__G__} or L{F_RAD__}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

@kwarg sep: Separator joining B{C{lls}} (C{str} or C{None}). 

 

@return: A C{str} or C{tuple} of B{C{sep}} is C{None} or C{NN}. 

''' 

if issequence(lls): 

t = tuple(ll.toStr(form=form, prec=prec) for ll in lls) 

if sep: 

t = sep.join(t) 

else: 

t = lls.toStr(form=form, prec=prec) 

return t 

 

 

def lonDMS(deg, form=F_DMS, prec=2, sep=S_SEP): 

'''Convert longitude to a string, optionally suffixed with E or W. 

 

@arg deg: Longitude to be formatted (C{degrees}). 

@kwarg form: Optional B{C{deg}} format (C{str} or L{F_D}, 

L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, 

L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, 

L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, 

L{F_SEC_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, 

L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, 

L{F_MIN__}, L{F_SEC__}, L{F__E__}, L{F__F__}, 

L{F__G__} or L{F_RAD__}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

@kwarg sep: Optional separator (C{str}). 

 

@return: Degrees in the specified form (C{str}). 

 

@JSname: I{toLon}. 

''' 

return _toDMS(deg, form, prec, sep, 3, _W_ if deg < 0 else _E_) 

 

 

def normDMS(strDMS, norm=NN): 

'''Normalize all degree ˚, minute ' and second " symbols in a 

string to the default symbols %s, %s and %s. 

 

@arg strDMS: DMS (C{str}). 

@kwarg norm: Optional replacement symbol, default symbol 

otherwise (C{str}). 

 

@return: Normalized DMS (C{str}). 

''' 

if norm: 

for s in _S_ALL: 

strDMS = strDMS.replace(s, norm) 

strDMS = strDMS.rstrip(norm) 

else: 

for s, S in _S_norm.items(): 

strDMS = strDMS.replace(s, S) 

return strDMS 

 

 

def parseDDDMMSS(strDDDMMSS, suffix=_NSEW_, sep=S_SEP, clip=0): 

'''Parse a lat- or longitude represention form [D]DDMMSS in degrees. 

 

@arg strDDDMMSS: Degrees in any of several forms (C{str}) and 

types (C{float}, C{int}, other). 

@kwarg suffix: Optional, valid compass points (C{str}, C{tuple}). 

@kwarg sep: Optional separator between "[D]DD", "MM" and "SS" (%r). 

@kwarg clip: Optionally, limit value to -clip..+clip (C{degrees}). 

 

@return: Degrees (C{float}). 

 

@raise ParseError: Invalid B{C{strDDDMMSS}} or B{C{clip}} or the 

B{C{strDDDMMSS}} form is incompatible with the 

suffixed or B{C{suffix}} compass point. 

 

@raise RangeError: Value of B{C{strDDDMMSS}} outside the valid 

range and L{rangerrors} set to C{True}. 

 

@note: Type C{str} values "[D]DD", "[D]DDMM" and "[D]DDMMSS" for 

B{C{strDDDMMSS}} are parsed properly only if I{either} 

unsigned and suffixed with a valid, compatible, C{cardinal} 

L{compassPoint} I{or} if unsigned or signed, unsuffixed and 

with keyword argument B{C{suffix}} set to B{%r}, B{%r} or a 

compatible L{compassPoint}. 

 

@note: Unlike function L{parseDMS}, type C{float}, C{int} and 

other non-C{str} B{C{strDDDMMSS}} values are interpreted 

form [D]DDMMSS. For example, C{int(1230)} is returned as 

12.5 I{and not 1230.0} degrees. However, C{int(345)} is 

considered form "DDD" 345 I{and not "DDMM" 0345}, unless 

B{C{suffix}} specifies compass point B{%r}. 

 

@see: Functions L{parseDMS}, L{parseDMS2} and L{parse3llh}. 

''' 

def _DDDMMSS_(strDDDMMSS, suffix, sep, clip): 

S = suffix.upper() 

if isstr(strDDDMMSS): 

t = strDDDMMSS.strip() 

if sep: 

t = t.replace(sep, NN).strip() 

 

s = t[:1] # sign or digit 

P = t[-1:] # compass point, digit or dot 

 

t = t.lstrip(_MINUS_PLUS_).rstrip(S).strip() 

f = t.split(_DOT_) 

d = len(f[0]) 

f = NN.join(f) 

if 1 < d < 8 and f.isdigit() and ( 

(P in S and s.isdigit()) or 

(P.isdigit() and s in '-0123456789+' # PYCHOK indent 

and S in ((_NS_, _EW_) + _WINDS))): 

# check [D]DDMMSS form and compass point 

X = _EW_ if (d & 1) else _NS_ 

if not (P in X or (S in X and (P.isdigit() or P == _DOT_))): 

t = 'DDDMMSS'[d & 1 ^ 1:d | 1], X[:1], X[1:] 

raise ParseError('form %s applies %s-%s' % t) 

f = 0 # fraction 

else: # try other forms 

return _DMS2deg(strDDDMMSS, S, sep, clip) 

 

else: # float or int to [D]DDMMSS[.fff] 

f = float(strDDDMMSS) 

s = _MINUS_ if f < 0 else NN 

P = _0_ # anything except _SW_ 

f, i = modf(abs(f)) 

t = '%.0f' % (i,) # str(i) == 'i.0' 

d = len(t) 

# bump number of digits to match 

# the given, valid compass point 

if S in (_NS_ if (d & 1) else _EW_): 

t = _0_ + t 

d += 1 

# P = S 

# elif d > 1: 

# P = (_EW_ if (d & 1) else _NS_)[0] 

 

if d < 4: # [D]DD[.ddd] 

if f: 

t = float(t) + f 

t = t, 0, 0 

else: 

f += float(t[d-2:]) 

if d < 6: # [D]DDMM[.mmm] 

t = t[:d-2], f, 0 

else: # [D]DDMMSS[.sss] 

t = t[:d-4], t[d-4:d-2], f 

d = _dms2deg(s, P, *map2(float, t)) 

 

return clipDegrees(d, float(clip)) if clip else d 

 

return _parseX(_DDDMMSS_, strDDDMMSS, suffix, sep, clip, 

strDDDMMSS=strDDDMMSS, suffix=suffix) 

 

 

if __debug__: # no __doc__ at -O and -OO 

parseDDDMMSS.__doc__ %= (S_SEP, _NS_, _EW_, _NS_) 

 

 

def _dms2deg(s, P, deg, min, sec): 

'''(INTERNAL) Helper for C{parseDDDMMSS} and C{parseDMS}. 

''' 

deg += (min + (sec / _60_0)) / _60_0 

if s == _MINUS_ or P in _SW_: 

deg = -deg 

return deg 

 

 

def _DMS2deg(strDMS, suffix, sep, clip): 

'''(INTERNAL) Helper for C{parseDDDMMSS} and C{parseDMS}. 

''' 

try: 

d = float(strDMS) 

 

except (TypeError, ValueError): 

strDMS = strDMS.strip() 

 

t = strDMS.lstrip(_MINUS_PLUS_).rstrip(suffix.upper()).strip() 

if sep: 

t = t.replace(sep, _SPACE_) 

for s in _S_ALL: 

t = t.replace(s, NN) 

else: 

for s in _S_ALL: 

t = t.replace(s, _SPACE_) 

t = map2(float, t.strip().split()) + (0, 0) 

d = _dms2deg(strDMS[:1], strDMS[-1:], *t[:3]) 

 

return clipDegrees(d, float(clip)) if clip else d 

 

 

def parseDMS(strDMS, suffix=_NSEW_, sep=S_SEP, clip=0): # MCCABE 14 

'''Parse a lat- or longitude representation C{"lat, lon"} in C{degrees}. 

 

This is very flexible on formats, allowing signed decimal 

degrees, degrees and minutes or degrees minutes and seconds 

optionally suffixed by a cardinal compass point. 

 

A variety of symbols, separators and suffixes are accepted, 

for example "3°37′09″W". Minutes and seconds may be omitted. 

 

@arg strDMS: Degrees in any of several forms (C{str}) and 

types (C{float}, C{int}, other). 

@kwarg suffix: Optional, valid compass points (C{str}, C{tuple}). 

@kwarg sep: Optional separator between deg°, min′ and sec″ ("''"). 

@kwarg clip: Optionally, limit value to -clip..+clip (C{degrees}). 

 

@return: Degrees (C{float}). 

 

@raise ParseError: Invalid B{C{strDMS}} or B{C{clip}}. 

 

@raise RangeError: Value of B{C{strDMS}} outside the valid range 

and L{rangerrors} set to C{True}. 

 

@note: Inlike function L{parseDDDMMSS}, type C{float}, C{int} 

and other non-C{str} B{C{strDMS}} values are considered 

as decimal degrees. For example, C{int(1230)} is returned 

as 1230.0 I{and not as 12.5} degrees and C{float(345)} as 

345.0 I{and not as 3.75} degrees! 

 

@see: Functions L{parseDDDMMSS}, L{parseDMS2} and L{parse3llh}. 

''' 

return _parseX(_DMS2deg, strDMS, suffix, sep, clip, strDMS=strDMS, suffix=suffix) 

 

 

def parseDMS2(strLat, strLon, sep=S_SEP, clipLat=90, clipLon=180): 

'''Parse a lat- and a longitude representions in C{degrees}. 

 

@arg strLat: Latitude in any of several forms (C{str} or C{degrees}). 

@arg strLon: Longitude in any of several forms (C{str} or C{degrees}). 

@kwarg sep: Optional separator between deg°, min′ and sec″ (''). 

@kwarg clipLat: Keep latitude in B{C{-clipLat..+clipLat}} range (C{degrees}). 

@kwarg clipLon: Keep longitude in B{C{-clipLon..+clipLon}} range (C{degrees}). 

 

@return: A L{LatLon2Tuple}C{(lat, lon)} in C{degrees}. 

 

@raise ParseError: Invalid B{C{strLat}} or B{C{strLon}}. 

 

@raise RangeError: Value of B{C{strLat}} or B{C{strLon}} outside the 

valid range and L{rangerrors} set to C{True}. 

 

@note: See the B{Notes} at function L{parseDMS}. 

 

@see: Functions L{parseDDDMMSS}, L{parseDMS} and L{parse3llh}. 

''' 

from pygeodesy.namedTuples import LatLon2Tuple # avoid circluar import 

 

return LatLon2Tuple(parseDMS(strLat, suffix=_NS_, sep=sep, clip=clipLat), 

parseDMS(strLon, suffix=_EW_, sep=sep, clip=clipLon)) 

 

 

def parse3llh(strllh, height=0, sep=_COMMA_, clipLat=90, clipLon=180): 

'''Parse a string C{"lat lon [h]"} representing lat-, longitude in 

C{degrees} and optional height in C{meter}. 

 

The lat- and longitude value must be separated by a separator 

character. If height is present it must follow, separated by 

another separator. 

 

The lat- and longitude values may be swapped, provided at least 

one ends with the proper compass point. 

 

@arg strllh: Latitude, longitude[, height] (C{str}, ...). 

@kwarg height: Optional, default height (C{meter}) or C{None}. 

@kwarg sep: Optional separator (C{str}). 

@kwarg clipLat: Keep latitude in B{C{-clipLat..+clipLat}} (C{degrees}). 

@kwarg clipLon: Keep longitude in B{C{-clipLon..+clipLon}} range (C{degrees}). 

 

@return: A L{LatLon3Tuple}C{(lat, lon, height)} in C{degrees}, 

C{degrees} and C{float}. 

 

@raise RangeError: Lat- or longitude value of B{C{strllh}} outside 

valid range and L{rangerrors} set to C{True}. 

 

@raise ValueError: Invalid B{C{strllh}} or B{C{height}}. 

 

@note: See the B{Notes} at function L{parseDMS}. 

 

@see: Functions L{parseDDDMMSS}, L{parseDMS} and L{parseDMS2}. 

 

@example: 

 

>>> parse3llh('000°00′05.31″W, 51° 28′ 40.12″ N') 

(51.4778°N, 000.0015°W, 0) 

''' 

from pygeodesy.namedTuples import LatLon3Tuple # avoid circluar import 

 

def _3llh_(strllh, height, sep): 

ll = strllh.strip().split(sep) 

if len(ll) > 2: # XXX interpret height unit 

h = float(ll.pop(2).strip().rstrip(_LETTERS).rstrip()) 

else: 

h = height # None from wgrs.Georef.__new__ 

if len(ll) != 2: 

raise ValueError 

 

a, b = [_.strip() for _ in ll] # PYCHOK false 

if a[-1:] in _EW_ or b[-1:] in _NS_: 

a, b = b, a 

return LatLon3Tuple(parseDMS(a, suffix=_NS_, clip=clipLat), 

parseDMS(b, suffix=_EW_, clip=clipLon), h) 

 

return _parseX(_3llh_, strllh, height, sep, strllh=strllh) 

 

 

def parseRad(strRad, suffix=_NSEW_, clip=0): 

'''Parse a string representing angle in C{radians}. 

 

@arg strRad: Degrees in any of several forms (C{str} or C{radians}). 

@kwarg suffix: Optional, valid compass points (C{str}, C{tuple}). 

@kwarg clip: Optionally, limit value to -clip..+clip (C{radians}). 

 

@return: Radians (C{float}). 

 

@raise ParseError: Invalid B{C{strRad}} or B{C{clip}}. 

 

@raise RangeError: Value of B{C{strRad}} outside the valid range 

and L{rangerrors} set to C{True}. 

''' 

def _Rad_(strRad, suffix, clip): 

try: 

r = float(strRad) 

 

except (TypeError, ValueError): 

strRad = strRad.strip() 

 

r = float(strRad.lstrip(_MINUS_PLUS_).rstrip(suffix.upper()).strip()) 

if strRad[:1] == _MINUS_ or strRad[-1:] in _SW_: 

r = -r 

 

return clipRadians(r, float(clip)) if clip else r 

 

return _parseX(_Rad_, strRad, suffix, clip, strRad=strRad, suffix=suffix) 

 

 

def precision(form, prec=None): 

'''Set the default precison for a given F_ form. 

 

@arg form: L{F_D}, L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, 

L{F_SEC}, L{F__E}, L{F__F}, L{F__G} or L{F_RAD} 

(C{str}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

 

@return: Previous precision (C{int}). 

 

@raise ValueError: Invalid B{C{form}} or B{C{prec}} or 

B{C{prec}} outside valid range. 

''' 

try: 

p = _F_prec[form] 

except KeyError: 

raise _ValueError(form=form) 

 

if prec is not None: 

from pygeodesy.units import Precision_ 

_F_prec[form] = Precision_(prec=prec, low=-9, high=9) 

 

return p 

 

 

def toDMS(deg, form=F_DMS, prec=2, sep=S_SEP, ddd=2, neg=_MINUS_, pos=NN): 

'''Convert I{signed} C{degrees} to string, without suffix. 

 

@arg deg: Degrees to be formatted (C{degrees}). 

@kwarg form: Optional B{C{deg}} format (C{str} or L{F_D}, 

L{F_DM}, L{F_DMS}, L{F_DEG}, L{F_MIN}, L{F_SEC}, 

L{F__E}, L{F__F}, L{F__G}, L{F_RAD}, L{F_D_}, 

L{F_DM_}, L{F_DMS_}, L{F_DEG_}, L{F_MIN_}, 

L{F_SEC_}, L{F__E_}, L{F__F_}, L{F__G_}, L{F_RAD_}, 

L{F_D__}, L{F_DM__}, L{F_DMS__}, L{F_DEG__}, 

L{F_MIN__}, L{F_SEC__}, L{F__E__}, L{F__F__}, 

L{F__G__} or L{F_RAD__}). 

@kwarg prec: Optional number of decimal digits (0..9 or 

C{None} for default). Trailing zero decimals 

are stripped for B{C{prec}} values of 1 and 

above, but kept for negative B{C{prec}}. 

@kwarg sep: Optional separator (C{str}). 

@kwarg ddd: Optional number of digits for deg° (2 or 3). 

@kwarg neg: Optional sign for negative degrees ('-'). 

@kwarg pos: Optional sign for positive degrees (''). 

 

@return: Degrees in the specified form (C{str}). 

''' 

t = _toDMS(deg, form, prec, sep, ddd, NN) 

if form[:1] not in _MINUS_PLUS_: 

t = (neg if deg < 0 else (pos if deg > 0 else NN)) + t 

return t 

 

# **) MIT License 

# 

# Copyright (C) 2016-2020 -- mrJean1 at Gmail -- All Rights Reserved. 

# 

# Permission is hereby granted, free of charge, to any person obtaining a 

# copy of this software and associated documentation files (the "Software"), 

# to deal in the Software without restriction, including without limitation 

# the rights to use, copy, modify, merge, publish, distribute, sublicense, 

# and/or sell copies of the Software, and to permit persons to whom the 

# Software is furnished to do so, subject to the following conditions: 

# 

# The above copyright notice and this permission notice shall be included 

# in all copies or substantial portions of the Software. 

# 

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 

# OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 

# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 

# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 

# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 

# OTHER DEALINGS IN THE SOFTWARE.