Moment_BDP — Moment_AT data (images and line information).¶
This module defines the Moment_BDP class.
-
class
admit.bdp.Moment_BDP.
Moment_BDP
(xmlFile=None, **keyval)[source]¶ Moment_BDP class.
Class for holding the data (images and line info) for a moment.
Parameters: xmlFile : str
Output XML file name.
keyval : dict
Dictionary of keyword : value pairs.
Attributes
moment (int) The moment that this BDP holds. line (Line) Instance of Line class to hold any information on the spectral line contained in the moment. image (Image) Instance of MultiImage class which holds the moment image, histogram, and any other representations of the data. Methods
addimage
(image[, name])Method to add an image to the class baseDir
([path])Get/set project base directory. delete
([delfiles])Method to delete the BDP. get
(key)Access an attribute. getdir
()Method to get the subdirectory(s) of the current BDP relative to the ADMIT working directory. getfiles
()Return the filename(s) associated with the basic data in a BDP. getimage
([imtype, name])Method to get a specific image type from the class getimagefile
([imtype, name])Method to get the requested image file name from the named instance haskey
(key)Query if a key exists for an BDP. isequal
(bdp)Tests for equality with another BDP. report
()Report BDP properties in human readable format. setkey
([name, key])Sets keyword value(s). show
()Show the xmlFile name. update
(new_state)Updates BDP state. write
([xmlFile])Writes the BDP to an XML file.