LineCube_AT — Cuts a cube into one or more line-oriented cubes.¶
This module defines the LineCube_AT class.
-
class
admit.at.LineCube_AT.LineCube_AT(**keyval)[source]¶ AT for generating a subcube of s specific spectral line.
See also LineCube_AT for design documentation.
The produced LineCube_BDP(s) holds a spectral cube for each of the specified spectral lines.
- Keywords
- pad: int
- Extra channels added on either side of a line (as given by the LineList). If a negative number is given, its positive value will be the number of channels of each linecube. This keyword has no meaning when gridding in velocity space is done. Default: 5 (add 5 channels to both sides of the line).
- fpad: float
- An optional way to control the padding would be to specify the fraction of the current line segment that is going to be added on either side of the segment. This would override the pad= keyword. Default: -1 (meaning not used)
- equalize: bool
- Whether or not to create equal size cubes (based on widest line in input LineList_BDP). These cubes will be padded based on the value of pad. Default: False.
Input BDPs
- Image_BDP: count: 1
- Spectral cube from which the line cube is sliced, as from an Ingest_AT or ContinuumSub_AT.
- LineList_BDP: count: 1
- List of spectral lines to cut (including the channel ranges), typically the output of a LineID_AT.
Output BDPs
- LineCube_BDP: count: varies
- The image slices of each spectral line (one for each).
Parameters: keyval : dictionary of keyword:value pairs, optional
Keyword values.
Attributes
_version (string) Version information. Methods
addinput(item[, slot])Add a BDP input to an AT. addinputbdp(item[, slot, insert])Add a BDP to the _bdp_in list. addoutput(item[, slot])Add a BDP output product to an AT. addoutputbdp(item[, slot, insert])Add a BDP to the _bdp_out list. baseDir([path])Get/set project base directory. bestMatch(at1, at2)Determines the better match of two tasks to the current one. checkfiles()Check if the files from all the BDP_out’s in an AT exist. checktype(item)Check the type of an object to see if it is a BDP. clearinput()Clear the input BDP list. clearoutput([delete])Clear the output BDP list. copy()Creates an independent duplicate of the task. delete()Method to delete the AT and underlying BDPs. delinput(slot)Delete a specific BDP in the _bdp_in list. deloutput(slot)Delete a specific BDP in the _bdp_out list. dir([filename])Absolute directory reference of the ADMIT project. dryrun()Method to do a dry run of the AT, generally just checks input values for errors. enabled([state])Returns current task enabled setting, with optional reset. execute([args])Executes the task. freeAlias(aliases[, alias])Deletes alias reservation, if present. get(attrib)Method to get the given attributes value getProject()Retrieves project ID associated with the task. getVersion()Return the version string. getdtd(fl)Method to write out the dtd data. geteffectivelevel()Method to get the effective logging level of the logging subsystem getkey(key)Retrieval value for a key. getloggername()Method to get the name of the logger for this AT instance getlogginglevel()Method to get the current logging level of the AT haskey(key)Query if a key exists for an AT. html(inheader)Method to represent the current AT in HTML format. id([strip])Returns task ID number. isAutoAlias([withEmpty, compat])Whether the task alias appears to be auto-generated. isequal(at)Method to determine if two ATs are the same. isstale()Returns whether the AT is out of date. len2()Returns the length of _bdp_in and _bdp_out in a tuple. link()Increments the task link count. markChanged()Mark an AT that it’s state was changed, so it would need to be rerun. markUpToDate()Resets _stale to indicate that the AT does not need to be run. merge(at[, aliases])Merges attributes from another task. mkdir(dirname)Make a directory in the ADMIT hierarchy. mkext(filename, ext[, alias])Return a new filename with a new extension with optional ADMIT alias. newId(tid)Assigns the task a new ID number. reset(a)Performs an in-place shallow copy. run()The run method, creates the slices, regrids if requested, and running([state])Returns current task execution flag, with optional reset. save()Save (write) any BDPs connected to this AT. set(item, val)Method to set protected attributes, rather than direct access setAlias(aliases[, alias, auto])Sets and registers the task alias, guaranteed unique among registered aliases. setProject(pid)Adds a project ID to task ID. set_bdp_in([bdpin])Validate the _valid_bdp_in list and digest it into the appropriate attributes. set_bdp_out([bout])Validate the _valid_bdp_out list and digest it into the appropriate attributes. seteffectivelevel(level)Method to set the effective logging level of the logging subsystem setkey([name, value, isinit])Set keyword value. setloggername(name)Method to set the name of the logger for this AT instance setlogginglevel(level)Method to set the logging level show()Return the AT type. statusicons()return some html icons representing the enabled/stale status of this task summary()Returns the summary dictionary for LineCube_AT”. unlink()Decrements the task link count. userdata()Returns the user dictionary from the AT, for merging into the ADMIT userdata object. validateinput([describe])Method to validate the _bdp_in’s against a dictionary of expected types. validatekeys()Method to error check all input keys. write(node)Method to write the AT to disk.