pts.visual.plotbands Namespace Reference

Plot built-in broadbands in a given wavelength range or of a given family. More...

Functions
def	plotBuiltinBands (minWavelength=1e-6 *u.micron, maxWavelength=1e6 *u.micron, nameSegments=None, *outDirPath=None, outFileName=None, outFilePath=None, figSize=(20, 6), interactive=None)
	This function creates a plot of the transmission curves for all built-in broadbands that satisfy the all of the specified selection criteria: More...

Detailed Description

Plot built-in broadbands in a given wavelength range or of a given family.

This module offers a function to create a plot of the transmission curves for all built-in broadbands with a pivot wavelength in a given wavelength range, and/or with a band name that contains specified segments.

Function Documentation

plotBuiltinBands()

def pts.visual.plotbands.plotBuiltinBands	(		minWavelength = 1e-6*u.micron,
			maxWavelength = 1e6*u.micron,
			nameSegments = None,
		*	outDirPath = None,
			outFileName = None,
			outFilePath = None,
			figSize = (20, 6),
			interactive = None
	)

This function creates a plot of the transmission curves for all built-in broadbands that satisfy the all of the specified selection criteria:

• minWavelength (astropy quantity): if specified, the pivot wavelength must exceed this value
• maxWavelength (astropy quantity): if specified, the pivot wavelength must be lower than this value
• nameSegments (string or iterable of strings): if specified, the band name must contain at least one of these segments

By default, the figure is saved as FigBuiltinBands.pdf in the current directory. This can be overridden with the out* arguments as described for the pts.utils.savePath() function. In interactive mode (see the pts.utils.interactive() function), the figure is not saved and it is left open so that is displayed in notebooks.