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

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

1001

1002

1003

1004

1005

1006

1007

1008

1009

1010

1011

1012

1013

1014

1015

1016

1017

1018

1019

1020

1021

1022

1023

1024

1025

1026

1027

1028

1029

1030

1031

1032

1033

1034

1035

1036

1037

1038

1039

1040

1041

1042

1043

1044

1045

1046

1047

1048

1049

1050

1051

1052

1053

1054

1055

1056

1057

1058

1059

1060

1061

1062

1063

1064

1065

1066

1067

1068

1069

1070

1071

1072

1073

1074

1075

1076

1077

1078

1079

1080

1081

1082

1083

1084

1085

1086

1087

1088

1089

1090

1091

1092

1093

1094

1095

1096

1097

1098

1099

1100

1101

1102

1103

1104

1105

1106

1107

1108

1109

1110

1111

1112

1113

1114

1115

1116

1117

1118

1119

1120

1121

1122

1123

1124

1125

1126

1127

1128

1129

1130

1131

1132

1133

1134

1135

1136

1137

1138

1139

1140

1141

1142

1143

1144

1145

1146

1147

1148

1149

1150

1151

1152

1153

1154

1155

1156

1157

1158

1159

1160

1161

1162

1163

1164

1165

1166

1167

1168

1169

1170

1171

1172

1173

1174

1175

1176

1177

1178

1179

1180

1181

1182

1183

1184

1185

1186

1187

1188

1189

1190

1191

1192

1193

1194

1195

1196

1197

1198

1199

1200

1201

1202

1203

1204

1205

1206

1207

1208

1209

1210

1211

1212

1213

1214

1215

1216

1217

1218

1219

1220

1221

1222

1223

1224

1225

1226

1227

1228

1229

1230

1231

1232

1233

1234

1235

1236

1237

1238

1239

1240

1241

1242

1243

1244

1245

1246

1247

1248

1249

1250

1251

1252

1253

1254

1255

1256

1257

1258

1259

1260

1261

1262

1263

1264

1265

1266

1267

1268

1269

1270

1271

1272

1273

1274

1275

1276

1277

1278

1279

1280

1281

1282

1283

1284

1285

1286

1287

1288

1289

1290

1291

1292

1293

1294

1295

1296

1297

1298

1299

1300

1301

1302

1303

1304

1305

1306

1307

1308

1309

1310

1311

1312

1313

1314

1315

1316

1317

1318

1319

1320

1321

1322

1323

1324

1325

1326

1327

1328

1329

1330

1331

1332

1333

1334

1335

1336

1337

1338

1339

1340

1341

1342

1343

1344

1345

1346

1347

1348

1349

1350

1351

1352

1353

1354

1355

1356

1357

1358

1359

1360

1361

1362

1363

1364

1365

1366

1367

1368

1369

1370

1371

1372

1373

1374

1375

1376

1377

1378

1379

1380

1381

1382

1383

1384

1385

1386

1387

1388

1389

1390

1391

1392

1393

1394

1395

1396

1397

1398

1399

1400

1401

1402

1403

1404

1405

1406

1407

1408

1409

1410

1411

1412

1413

1414

1415

1416

1417

1418

1419

1420

1421

1422

1423

1424

1425

1426

1427

1428

1429

1430

1431

1432

1433

1434

1435

1436

1437

1438

1439

1440

1441

1442

1443

1444

1445

1446

1447

1448

1449

1450

1451

1452

1453

1454

1455

1456

1457

1458

1459

1460

1461

1462

1463

1464

1465

1466

1467

1468

1469

1470

1471

1472

1473

1474

1475

1476

1477

1478

1479

1480

1481

1482

1483

1484

1485

1486

1487

1488

1489

1490

1491

1492

1493

1494

1495

1496

1497

1498

1499

1500

1501

1502

1503

1504

1505

1506

1507

1508

1509

1510

1511

1512

1513

1514

1515

1516

1517

1518

1519

1520

1521

1522

1523

1524

1525

1526

1527

1528

1529

1530

1531

1532

1533

1534

1535

1536

1537

1538

1539

1540

1541

1542

1543

1544

1545

1546

1547

1548

1549

1550

1551

1552

1553

1554

1555

1556

1557

1558

1559

1560

1561

1562

1563

1564

1565

1566

1567

1568

1569

1570

1571

1572

1573

# This file was automatically generated by SWIG (http://www.swig.org). 

# Version 2.0.4 

# 

# Do not make changes to this file unless you know what you are doing--modify 

# the SWIG interface file instead. 

 

 

 

from sys import version_info 

if version_info >= (2,6,0): 

    def swig_import_helper(): 

        from os.path import dirname 

        import imp 

        fp = None 

        try: 

            fp, pathname, description = imp.find_module('_plotms', [dirname(__file__)]) 

        except ImportError: 

            import _plotms 

            return _plotms 

        if fp is not None: 

            try: 

                _mod = imp.load_module('_plotms', fp, pathname, description) 

            finally: 

                fp.close() 

            return _mod 

    _plotms = swig_import_helper() 

    del swig_import_helper 

else: 

    import _plotms 

del version_info 

try: 

    _swig_property = property 

except NameError: 

    pass # Python < 2.2 doesn't have 'property'. 

def _swig_setattr_nondynamic(self,class_type,name,value,static=1): 

    if (name == "thisown"): return self.this.own(value) 

    if (name == "this"): 

        if type(value).__name__ == 'SwigPyObject': 

            self.__dict__[name] = value 

            return 

    method = class_type.__swig_setmethods__.get(name,None) 

    if method: return method(self,value) 

    if (not static): 

        self.__dict__[name] = value 

    else: 

        raise AttributeError("You cannot add attributes to %s" % self) 

 

def _swig_setattr(self,class_type,name,value): 

    return _swig_setattr_nondynamic(self,class_type,name,value,0) 

 

def _swig_getattr(self,class_type,name): 

    if (name == "thisown"): return self.this.own() 

    method = class_type.__swig_getmethods__.get(name,None) 

    if method: return method(self) 

    raise AttributeError(name) 

 

def _swig_repr(self): 

    try: strthis = "proxy of " + self.this.__repr__() 

    except: strthis = "" 

    return "<%s.%s; %s >" % (self.__class__.__module__, self.__class__.__name__, strthis,) 

 

try: 

    _object = object 

    _newclass = 1 

except AttributeError: 

    class _object : pass 

    _newclass = 0 

 

 

class plotms(_object): 

    """Proxy of C++ casac::plotms class""" 

    __swig_setmethods__ = {} 

    __setattr__ = lambda self, name, value: _swig_setattr(self, plotms, name, value) 

    __swig_getmethods__ = {} 

    __getattr__ = lambda self, name: _swig_getattr(self, plotms, name) 

    __repr__ = _swig_repr 

    def __init__(self): 

        """__init__(self) -> plotms""" 

        this = _plotms.new_plotms() 

        try: self.this.append(this) 

        except: self.this = this 

    __swig_destroy__ = _plotms.delete_plotms 

    __del__ = lambda self : None; 

    def setLogFilename(self, *args, **kwargs): 

        """ 

        setLogFilename(self, logFilename = string("casapy.log")) 

 

        Summary 

                Sets the log filename to be used by plotms. 

 

        Description 

                 

 

        Input Parameters: 

                logFilename      log filename for plotms to use casapy.log  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setLogFilename(self, *args, **kwargs) 

 

    def getLogFilename(self): 

        """ 

        getLogFilename(self) -> string 

 

        Summary 

                Gets the log filename used by plotms. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getLogFilename(self) 

 

    def setLogFilter(self, *args, **kwargs): 

        """ 

        setLogFilter(self, priority) 

 

        Summary 

                Sets the log's priority filter. 

 

        Description 

                 

 

        Input Parameters: 

                priority         string representation of minimum priority  

                 

        Example: 

                 

           

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setLogFilter(self, *args, **kwargs) 

 

    def getLogFilter(self): 

        """ 

        getLogFilter(self) -> string 

 

        Summary 

                Gets the log's priority filter. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getLogFilter(self) 

 

    def setClearSelectionOnAxesChange(self, *args, **kwargs): 

        """ 

        setClearSelectionOnAxesChange(self, clearSelection) 

 

        Summary 

                Sets whether any selections are cleared on an axes change or not. 

 

        Description 

                 

 

        Input Parameters: 

                clearSelection   clear selection flag  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setClearSelectionOnAxesChange(self, *args, **kwargs) 

 

    def getClearSelectionOnAxesChange(self): 

        """ 

        getClearSelectionOnAxesChange(self) -> bool 

 

        Summary 

                Gets whether any selections are cleared on an axes change or not. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getClearSelectionOnAxesChange(self) 

 

    def setCachedImageSize(self, *args, **kwargs): 

        """ 

        setCachedImageSize(self, width, height) 

 

        Summary 

                Sets the size for the cached images. 

 

        Description 

                 

 

        Input Parameters: 

                width            width of the cached images  

                height           height of the cached images  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setCachedImageSize(self, *args, **kwargs) 

 

    def setCachedImageSizeToScreenResolution(self): 

        """ 

        setCachedImageSizeToScreenResolution(self) 

 

        Summary 

                Sets the size for the cached images to the current screen resolution. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setCachedImageSizeToScreenResolution(self) 

 

    def getCachedImageWidth(self): 

        """ 

        getCachedImageWidth(self) -> int 

 

        Summary 

                Gets the width of the cached images. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getCachedImageWidth(self) 

 

    def getCachedImageHeight(self): 

        """ 

        getCachedImageHeight(self) -> int 

 

        Summary 

                Gets the height of the cached images. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getCachedImageHeight(self) 

 

    def setGridSize(self, rowCount = 1, colCount = 1): 

        """ 

        setGridSize(self, rowCount = 1, colCount = 1) 

 

        Summary 

                Sets the number of rows and columns in multiple plot displays. 

 

        Description 

                 

 

        Input Parameters: 

                rowCount         The number of rows in a multiple plot display. 1  

                colCount         The number of columns in a multiple plot display. 1  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setGridSize(self, rowCount, colCount) 

 

    def setPlotMSFilename(self, *args, **kwargs): 

        """ 

        setPlotMSFilename(self, msFilename, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS filename to the given. 

 

        Description 

                 

        Sets the MS filename for the plot at the given index.  If updateImmediately is 

        true, this change takes effect immediately IF the plotms window is currently 

        shown; otherwise it will only be applied next time update() and/or show() is 

        called. 

           

 

        Input Parameters: 

                msFilename       MS filename to be plotted  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSFilename(self, *args, **kwargs) 

 

    def getPlotMSFilename(self, plotIndex = 0): 

        """ 

        getPlotMSFilename(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the MS filename. 

 

        Description 

                 

        Gets the MS filename for the plot at the given index. 

           

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotMSFilename(self, plotIndex) 

 

    def setcallib(self, *args, **kwargs): 

        """ 

        setcallib(self, callib, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the calibration parameters. 

 

        Description 

                 

        Sets the calibration parameters for the plot at the given index, using a 

        record.  If updateImmediately is true, this change takes effect immediately IF 

        the plotms window is currently shown; otherwise it will only be applied next 

        time update() and/or show() is called. 

           

 

        Input Parameters: 

                callib           calibration parameters, in record form  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setcallib(self, *args, **kwargs) 

 

    def setPlotMSSelection(self, *args, **kwargs): 

        """ 

        setPlotMSSelection(self, field = string(""), spw = string(""), timerange = string(""),  

            uvrange = string(""), antenna = string(""),  

            scan = string(""), corr = string(""),  

            array = string(""), observation = string(""),  

            intent = string(""), msselect = string(""),  

            updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS selection parameters. 

 

        Description 

                 

        Sets the MS selection parameters for the plot at the given index, using 

        individual string values.  If updateImmediately is true, this change takes 

        effect immediately IF the plotms window is currently shown; otherwise it will 

        only be applied next time update() and/or show() is called. 

           

 

        Input Parameters: 

                field            MS selection parameter for field  

                spw              MS selection parameter for spw  

                timerange        MS selection parameter for timerange  

                uvrange          MS selection parameter for uvrange  

                antenna          MS selection parameter for antenna  

                scan             MS selection parameter for scan  

                corr             MS selection parameter for corr  

                array            MS selection parameter for array  

                observation      MS selection parameter for obsID  

                intent           MS selection parameter for intent  

                msselect         MS selection parameter for msselect  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSSelection(self, *args, **kwargs) 

 

    def setPlotMSSelectionRec(self, *args, **kwargs): 

        """ 

        setPlotMSSelectionRec(self, selection, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS selection parameters. 

 

        Description 

                 

        Sets the MS selection parameters for the plot at the given index, using a 

        record (see PlotMSSelection::toRecord()).  If updateImmediately is true, this 

        change takes effect immediately IF the plotms window is currently shown; 

        otherwise it will only be applied next time update() and/or show() is called. 

           

 

        Input Parameters: 

                selection        MS selection parameters, in record form  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSSelectionRec(self, *args, **kwargs) 

 

    def getPlotMSSelection(self, plotIndex = 0): 

        """ 

        getPlotMSSelection(self, plotIndex = 0) -> record 

 

        Summary 

                Gets the MS selection parameters. 

 

        Description 

                 

        Gets the MS selection parameters for the plot at the given index as a record 

        (see PlotMSSelection::toRecord()). 

           

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotMSSelection(self, plotIndex) 

 

    def setPlotMSAveraging(self, *args, **kwargs): 

        """ 

        setPlotMSAveraging(self, channel = string(""), time = string(""), scan = False,  

            field = False, baseline = False, antenna = False,  

            spw = False, scalar = False, updateImmediately = True,  

            plotIndex = 0) 

 

        Summary 

                Sets the MS averaging parameters. 

 

        Description 

                 

        Sets the MS averaging parameters for the plot at the given index, using 

        individual flags and values.  Baseline and antenna averaging are mutually 

        exclusive; only one (or none) can be true at the same time.  If 

        updateImmediately is true, this change takes effect immediately IF the plotms 

        window is currently shown; otherwise it will only be applied next time update() 

        and/or show() is called. 

           

 

        Input Parameters: 

                channel          channel averaging; either blank or a channel value  

                time             time averaging; either blank or a value in seconds  

                scan             scan averaging (only valid if time averaging is on) false  

                field            field averaging (only valid if time averaging is on) false  

                baseline         baseline averaging, mutually exclusive with antenna false  

                antenna          antenna averaging, mutually exclusive with baseline false  

                spw              spw averaging false  

                scalar           Do scalar averaging instead of vector averaging false  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSAveraging(self, *args, **kwargs) 

 

    def setPlotMSAveragingRec(self, *args, **kwargs): 

        """ 

        setPlotMSAveragingRec(self, averaging, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS averaging parameters. 

 

        Description 

                 

        Sets the MS averaging parameters for the plot at the given index, using a 

        record (see PlotMSAveraging::toRecord()).  If updateImmediately is true, this 

        change takes effect immediately IF the plotms window is currently shown; 

        otherwise it will only be applied next time update() and/or show() is called. 

           

 

        Input Parameters: 

                averaging        MS averaging parameters, in record form  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSAveragingRec(self, *args, **kwargs) 

 

    def getPlotMSAveraging(self, plotIndex = 0): 

        """ 

        getPlotMSAveraging(self, plotIndex = 0) -> record 

 

        Summary 

                Gets the MS averaging parameters. 

 

        Description 

                 

        Gets the MS averaging parameters for the plot at the given index as a record 

        (see PlotMSAveraging::toRecord()). 

           

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotMSAveraging(self, plotIndex) 

 

    def setPlotMSTransformations(self, *args, **kwargs): 

        """ 

        setPlotMSTransformations(self, freqframe = string(""), veldef = string(""), restfreq = initialize_variant(""),  

            xshift = 0.0, yshift = 0.0,  

            updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS transformation parameters. 

 

        Description 

                 

        Sets the MS transformation parameters for the plot at the given index, using 

        individual values.  Supported transformations currently include frequency 

        frame choices (TOPO,GEO,BARY,LSRK,LSRD), velocity definition choices (RADIO, 

        OPTICAL,TRUE) and rest frequency, and phase center shift.  If 

        updateImmediately is true, this change takes effect immediately IF the plotms 

        window is currently shown; otherwise it will only be applied next time update() 

        and/or show() is called. 

           

 

        Input Parameters: 

                freqframe        Frequency frame in which to render frequencies and velocities  

                veldef           Velocity definition in which to render velocities  

                restfreq         Rest frequency (w/ units) to use when calculating velocities  

                xshift           Phase center shift in horizontal direction (arcsec) 0.0  

                yshift           Phase center shift in vertical direction (arcsec) 0.0  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSTransformations(self, *args, **kwargs) 

 

    def setPlotMSCalibration(self, *args, **kwargs): 

        """ 

        setPlotMSCalibration(self, use = False, filename = string(""), callib = initialize_record(""),  

            updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS calibration parameters. 

 

        Description 

                 

        Sets the MS calibration parameters for the plot at the given index, using 

        individual values.  These parameters may be in a record (python dictionary) or 

        a file.  If updateImmediately is true, this change takes effect immediately IF 

        the plotms window is currently shown; otherwise it will only be applied next 

        time update() and/or show() is called. 

           

 

        Input Parameters: 

                use              Indicates whether to use a calibration library for on-the-fly calibration. false  

                filename         Calibration Library filename  

                callib           Rest frequency (w/ units) to use when calculating velocities  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSCalibration(self, *args, **kwargs) 

 

    def setPlotMSIterate(self, *args, **kwargs): 

        """ 

        setPlotMSIterate(self, iteraxis = string(""), rowIndex = 0, colIndex = 0,  

            xselfscale = False, yselfscale = False, commonAxisX = False,  

            commonAxisY = False, updateImmediately = True,  

            plotIndex = 0) 

 

        Summary 

                Sets the iteration parameters. 

 

        Description 

                 

        Sets which meta-information axis over which to iterate the plots 

        (scan, field, spw, baseline, antenna), and whether to self-scale  

        the axes of each plot or scale them globally.  (TBD: support for  

        specifying multiple plots per page will be added here) 

           

 

        Input Parameters: 

                iteraxis         Axis over which to iterate (or none)  

                rowIndex         Row location of the plot (0-based, default=0). 0  

                colIndex         Column location of the plot (0-based, default=0) 0  

                xselfscale       If true, iterated plots should share a common x-axis label per column. false  

                yselfscale       If true, iterated plots should share a common y-axis label per row. false  

                commonAxisX      Plots should share a common x-axis. false  

                commonAxisY      Plots should share a common y-axis. false  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSIterate(self, *args, **kwargs) 

 

    def setPlotMSTransformationsRec(self, *args, **kwargs): 

        """ 

        setPlotMSTransformationsRec(self, transformations, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS transformations parameters. 

 

        Description 

                 

        Sets the MS transformations parameters for the plot at the given index, using a 

        record (see PlotMSTransformations::toRecord()).  If updateImmediately is true, this 

        change takes effect immediately IF the plotms window is currently shown; 

        otherwise it will only be applied next time update() and/or show() is called. 

           

 

        Input Parameters: 

                transformations  MS transformations parameters, in record form  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSTransformationsRec(self, *args, **kwargs) 

 

    def getPlotMSTransformations(self, plotIndex = 0): 

        """ 

        getPlotMSTransformations(self, plotIndex = 0) -> record 

 

        Summary 

                Gets the MS transformations parameters. 

 

        Description 

                 

        Gets the MS transformations parameters for the plot at the given index as a record 

        (see PlotMSTransformations::toRecord()). 

           

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotMSTransformations(self, plotIndex) 

 

    def setPlotMSCalibrationRec(self, *args, **kwargs): 

        """ 

        setPlotMSCalibrationRec(self, calibration, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the MS calibration parameters. 

 

        Description 

                 

        Sets the MS calibration parameters for the plot at the given index, using a 

        record (see PlotMSCalibration::toRecord()).  If updateImmediately is true, this 

        change takes effect immediately IF the plotms window is currently shown; 

        otherwise it will only be applied next time update() and/or show() is called. 

           

 

        Input Parameters: 

                calibration      MS calibration parameters, in record form  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotMSCalibrationRec(self, *args, **kwargs) 

 

    def getPlotMSCalibration(self, plotIndex = 0): 

        """ 

        getPlotMSCalibration(self, plotIndex = 0) -> record 

 

        Summary 

                Gets the MS calibration parameters. 

 

        Description 

                 

        Gets the MS calibration parameters for the plot at the given index as a record 

        (see PlotMSCalibration::toRecord()). 

           

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotMSCalibration(self, plotIndex) 

 

    def setExportRange(self, *args, **kwargs): 

        """ 

        setExportRange(self, range = string("")) 

 

        Summary 

                Export all iteration plots or only the current one. 

 

        Description 

                 

                Plot export range (for multiple page iterations): All plots or only the current one (blank). 

           

 

        Input Parameters: 

                range            Iteration plot export range: all or current(blank).  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setExportRange(self, *args, **kwargs) 

 

    def setTitle(self, *args, **kwargs): 

        """ 

        setTitle(self, text = string(""), updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the title for a plot 

 

        Description 

                 

 

        Input Parameters: 

                text             Title (blank for automatic, resembling [yaxis] vs. [x])  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setTitle(self, *args, **kwargs) 

 

    def setXAxisLabel(self, *args, **kwargs): 

        """ 

        setXAxisLabel(self, text = string(""), updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the text to label the horizontal axis 

 

        Description 

                 

 

        Input Parameters: 

                text             The title (blank for automatic)  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setXAxisLabel(self, *args, **kwargs) 

 

    def setYAxisLabel(self, *args, **kwargs): 

        """ 

        setYAxisLabel(self, text = string(""), updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the text to label the vertical axis 

 

        Description 

                 

 

        Input Parameters: 

                text             The text (blank for automatic)  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setYAxisLabel(self, *args, **kwargs) 

 

    def getTitle(self, plotIndex = 0): 

        """ 

        getTitle(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the title for the plot 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getTitle(self, plotIndex) 

 

    def getXAxisLabel(self, plotIndex = 0): 

        """ 

        getXAxisLabel(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the text for the horizontal axis 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getXAxisLabel(self, plotIndex) 

 

    def getYAxisLabel(self, plotIndex = 0): 

        """ 

        getYAxisLabel(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the text for the vertical axis 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getYAxisLabel(self, plotIndex) 

 

    def setPlotAxes(self, *args, **kwargs): 

        """ 

        setPlotAxes(self, xAxis = string(""), yAxis = string(""), xDataColumn = string(""),  

            yDataColumn = string(""), yAxisLocation = string(""),  

            updateImmediately = True,  

            plotIndex = 0, dataIndex = 0) 

 

        Summary 

                Sets the plot axes to the given. 

 

        Description 

                 

        Sets the x and y plot axes and data columns, as Strings.  If updateImmediately 

        is true, this change takes effect immediately IF the plotms window is currently 

        shown; otherwise it will only be applied next time update() and/or show() is 

        called. 

           

 

        Input Parameters: 

                xAxis            name of the axis choice for x (blank to keep current)  

                yAxis            name of the axis choice for y (blank to keep current)  

                xDataColumn      name of the data column to use for the x axis, if applicable (blank to keep current)  

                yDataColumn      name of the data column to use for the y axis, if applicable (blank to keep current)  

                yAxisLocation    The whether to plot the y-data against a left or right axis (blank for default)  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                dataIndex        When overplotting data, the index of the data being overplotted. 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setPlotAxes(self, *args, **kwargs) 

 

    def getPlotXAxis(self, plotIndex = 0): 

        """ 

        getPlotXAxis(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the x plot axis. 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotXAxis(self, plotIndex) 

 

    def getPlotXDataColumn(self, plotIndex = 0): 

        """ 

        getPlotXDataColumn(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the data column for the x plot axis. 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotXDataColumn(self, plotIndex) 

 

    def getPlotYAxis(self, plotIndex = 0): 

        """ 

        getPlotYAxis(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the y plot axis. 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotYAxis(self, plotIndex) 

 

    def getPlotYDataColumn(self, plotIndex = 0): 

        """ 

        getPlotYDataColumn(self, plotIndex = 0) -> string 

 

        Summary 

                Gets the data column for the y plot axis. 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotYDataColumn(self, plotIndex) 

 

    def getPlotParams(self, plotIndex = 0): 

        """ 

        getPlotParams(self, plotIndex = 0) -> record 

 

        Summary 

                Returns the plot params. 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getPlotParams(self, plotIndex) 

 

    def setXRange(self, xautorange = True, xmin = 0, xmax = 0, updateImmediately = True, 

    plotIndex = 0): 

        """ 

        setXRange(self, xautorange = True, xmin = 0, xmax = 0, updateImmediately = True,  

            plotIndex = 0) 

 

        Summary 

                Set X axis for auto or manual, and the min/max values of x 

 

        Input Parameters: 

                xautorange       Automatically determine X axrangeis range? true  

                xmin             Minimum value of X 0  

                xmax             Maximum value of X 0  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setXRange(self, xautorange, xmin, xmax, updateImmediately, plotIndex) 

 

    def setYRange(self, yautorange = True, ymin = 0, ymax = 0, updateImmediately = True, 

    plotIndex = 0): 

        """ 

        setYRange(self, yautorange = True, ymin = 0, ymax = 0, updateImmediately = True,  

            plotIndex = 0) 

 

        Summary 

                Set Y axis for auto or manual, and the min/max values of y 

 

        Input Parameters: 

                yautorange       Automatically determine X axis range? true  

                ymin             Minimum value of Y 0  

                ymax             Maximum value of Y 0  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setYRange(self, yautorange, ymin, ymax, updateImmediately, plotIndex) 

 

    def setColorizeFlag(self, *args, **kwargs): 

        """ 

        setColorizeFlag(self, colorize, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the plot x axis to the given. 

 

        Description 

                 

        Sets the colorization plot axis, as Strings.  If updateImmediately is 

        true, this change takes effect immediately IF the plotms window is currently 

        shown; otherwise it will only be applied next time update() and/or show() is 

        called. 

           

 

        Input Parameters: 

                colorize         name of the axis choice for x (blank to keep current)  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setColorizeFlag(self, *args, **kwargs) 

 

    def getColorizeFlag(self, plotIndex = 0): 

        """ 

        getColorizeFlag(self, plotIndex = 0) -> bool 

 

        Summary 

                Get colorization flag 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getColorizeFlag(self, plotIndex) 

 

    def setColorAxis(self, *args, **kwargs): 

        """ 

        setColorAxis(self, coloraxis, updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Sets the plot x axis to the given. 

 

        Description 

                 

        Sets the colorization plot axis, as Strings.  If updateImmediately is 

        true, this change takes effect immediately IF the plotms window is currently 

        shown; otherwise it will only be applied next time update() and/or show() is 

        called. 

           

 

        Input Parameters: 

                coloraxis        name of the axis choice for x (blank to keep current)  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setColorAxis(self, *args, **kwargs) 

 

    def setSymbol(self, *args, **kwargs): 

        """ 

        setSymbol(self, shape = string("autoscaling"), size = 2, color = string("0000ff"),  

            fill = string("fill"), outline = False,  

            updateImmediately = True, plotIndex = 0,  

            dataIndex = 0) 

 

        Summary 

                Sets the unflagged plot symbol 

 

        Description 

                 

        Sets the unflagged plot symbol properties: shape, size, color, fill,  

        and outline. 

           

 

        Input Parameters: 

                shape            symbol shape (autoscaling, circle, square, diamond, pixel, nosymbol) autoscaling  

                size             size of the symbol in pts 2  

                color            color of the symbol, in hex (ex. '0000ff') 0000ff  

                fill             point fill type (fill, mesh1, mesh2, mesh3, no fill) fill  

                outline          sets outline on plotted points False  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                dataIndex        the index of the data in an overplot to apply this change 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setSymbol(self, *args, **kwargs) 

 

    def setFlaggedSymbol(self, *args, **kwargs): 

        """ 

        setFlaggedSymbol(self, shape = string("nosymbol"), size = 2, color = string("ff0000"),  

            fill = string("fill"), outline = False,  

            updateImmediately = True, plotIndex = 0,  

            dataIndex = 0) 

 

        Summary 

                Sets the flagged plot symbol 

 

        Description 

                 

        Sets the flagged plot symbol properties: shape, size, color, fill,  

        and outline. 

           

 

        Input Parameters: 

                shape            flagged symbol shape (autoscaling, circle, square, diamond, pixel, nosymbol) nosymbol  

                size             size of the flaggedsymbol in pts 2  

                color            color of the flagged symbol, in hex (ex. 'ff0000') ff0000  

                fill             flagged point fill type (fill, mesh1, mesh2, mesh3, no fill) fill  

                outline          sets outline on plotted flagged points False  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                dataIndex        the index of the data in an overplot plot to apply this change 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setFlaggedSymbol(self, *args, **kwargs) 

 

    def getColorAxis(self, plotIndex = 0): 

        """ 

        getColorAxis(self, plotIndex = 0) -> string 

 

        Summary 

                What data controls the colorizing? 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getColorAxis(self, plotIndex) 

 

    def setFlagExtension(self, *args, **kwargs): 

        """ 

        setFlagExtension(self, extend = False, correlation = string(""), channel = False,  

            spw = False, antenna = string(""), time = False,  

            scans = False, field = False, alternateSelection = initialize_record("")) 

 

        Summary 

                Sets the flag extension parameters. 

 

        Description 

                 

        Sets the flag extension parameters, using individual flags and values.  Takes 

        effect next time flagging is done. 

           

 

        Input Parameters: 

                extend           whether to extend flags or not false  

                correlation      extend on correlation; one of: '', 'all', 'poln-dep'  

                channel          extend on channel false  

                spw              extend on spw false  

                antenna          extend on antenna; one of: '', 'all', antenna-based value  

                time             extend on time false  

                scans            extend on scans (only valid if time is true) false  

                field            extend on field (only valid if time is true) false  

                alternateSelection       alternate MS selection, in record form, or empty record for none  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setFlagExtension(self, *args, **kwargs) 

 

    def setFlagExtensionRec(self, *args, **kwargs): 

        """ 

        setFlagExtensionRec(self, flagExtension) 

 

        Summary 

                Sets the flag extension parameters. 

 

        Description 

                 

        Sets the flag extension parameters, using a record (see 

        PlotMSFlagging::toRecord()).  Takes effect next time flagging is done. 

           

 

        Input Parameters: 

                flagExtension    flag extension parameters, in record form  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setFlagExtensionRec(self, *args, **kwargs) 

 

    def getFlagExtension(self): 

        """ 

        getFlagExtension(self) -> record 

 

        Summary 

                Gets the flag extension parameters. 

 

        Description 

                 

        Gets the flag extension parameters as a record (see 

        PlotMSFlagging::toRecord()). 

           

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getFlagExtension(self) 

 

    def locateInfo(self): 

        """ 

        locateInfo(self) -> record 

 

        Summary 

                Locates points in a specified region. 

 

        Description 

                 

        Locates points in all selected plot regions and returns their meta information as a record (see PlotMSFlagging::toRecord()).  If there are no selections, all plotted points are returned. 

           

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_locateInfo(self) 

 

    def getGridMajorShown(self, plotIndex = 0): 

        """ 

        getGridMajorShown(self, plotIndex = 0) -> bool 

 

        Summary 

                Gets state of visibililty of major grid lines 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getGridMajorShown(self, plotIndex) 

 

    def getGridMinorShown(self, plotIndex = 0): 

        """ 

        getGridMinorShown(self, plotIndex = 0) -> bool 

 

        Summary 

                Gets state of visibililty of minor grid lines 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getGridMinorShown(self, plotIndex) 

 

    def getGridMajorWidth(self, plotIndex = 1): 

        """ 

        getGridMajorWidth(self, plotIndex = 1) -> int 

 

        Summary 

                Gets width of major grid lines 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 1  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getGridMajorWidth(self, plotIndex) 

 

    def getGridMinorWidth(self, plotIndex = 1): 

        """ 

        getGridMinorWidth(self, plotIndex = 1) -> int 

 

        Summary 

                Gets width of minor grid lines 

 

        Description 

                 

 

        Input Parameters: 

                plotIndex        Index of the plot (0-based). 1  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_getGridMinorWidth(self, plotIndex) 

 

    def setGridParams(self, *args, **kwargs): 

        """ 

        setGridParams(self, showmajorgrid = False, majorwidth = 1, majorstyle = string("solid"),  

            majorcolor = string("B0B0B0"),  

            showminorgrid = False, minorwidth = 1, minorstyle = string("solid"),  

            minorcolor = string("C0CCE0"),  

            updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Set color, style for major and minor grid lines 

 

        Description 

                 

 

        Input Parameters: 

                showmajorgrid    Show major grid lines (horiz. and vert.)? false  

                majorwidth       Line width for major grid lines, pixels 1  

                majorstyle       Line style for major grid lines solid  

                majorcolor       Color of major grid lines B0B0B0  

                showminorgrid    Show minor grid lines (horiz. and vert.)? false  

                minorwidth       Line width for minor grid lines, pixels 1  

                minorstyle       Line style for minor grid lines solid  

                minorcolor       Color of minor grid lines C0CCE0  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setGridParams(self, *args, **kwargs) 

 

    def setLegend(self, *args, **kwargs): 

        """ 

        setLegend(self, showLegend = False, legendPosition = string("upperright"),  

            updateImmediately = True, plotIndex = 0) 

 

        Summary 

                Set whether or not to display a legend and the position of a legend. 

 

        Description 

                 

 

        Input Parameters: 

                showLegend       Show a legend with the plot? false  

                legendPosition   Location for the legend. upperright  

                updateImmediately        whether to apply this change immediately, IF the window is currently shown true  

                plotIndex        Index of the plot (0-based). 0  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setLegend(self, *args, **kwargs) 

 

    def update(self): 

        """ 

        update(self) -> bool 

 

        Summary 

                Updates the running plotms with any un-applied changes. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_update(self) 

 

    def save(self, *args, **kwargs): 

        """ 

        save(self, plotfile, format, highres = False) -> bool 

 

        Summary 

                save plot to file 

 

        Description 

                Save the plot to a file 

 

        Input Parameters: 

                plotfile         name of plot file  

                format           Format type, if not provided, attempt will be made to guess from plotfile extension  

                highres          Use high resolution? Always true for jpg and png. false  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_save(self, *args, **kwargs) 

 

    def isDrawing(self): 

        """ 

        isDrawing(self) -> bool 

 

        Summary 

                Is the plot being drawn? 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_isDrawing(self) 

 

    def isClosed(self): 

        """ 

        isClosed(self) -> bool 

 

        Summary 

                Has the plot received a closeEvent? 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_isClosed(self) 

 

    def setShowGui(self, *args, **kwargs): 

        """ 

        setShowGui(self, show) 

 

        Summary 

                Show a GUI supporting user interaction. 

 

        Description 

                 

 

        Input Parameters: 

                show             If true, provide a GUI supporting interaction, else operate in scripting mode.  

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_setShowGui(self, *args, **kwargs) 

 

    def clearPlots(self): 

        """ 

        clearPlots(self) 

 

        Summary 

                Remove existing plots so that new plots can replace them. 

 

        Description 

                 

        Example: 

                 

        -------------------------------------------------------------------------------- 

                       

        """ 

        return _plotms.plotms_clearPlots(self) 

 

plotms_swigregister = _plotms.plotms_swigregister 

plotms_swigregister(plotms) 

 

# This file is compatible with both classic and new-style classes.