# OverlapIntegral_AT — Computes the overlap integral between images.¶

This module defines the OverlapIntegral_AT class.

class admit.at.OverlapIntegral_AT.OverlapIntegral_AT(**keyval)[source]

Compute an overlap integral between selected images (or cubes).

Images (or cubes) need to have a confirming WCS. It also makes sense if the input maps have the same resolving power, see also Smooth_AT — Creates a smoothed version of a cube. how to achieve this.

Keywords

chans: string
If selected (for cubes), this is the channel range over which data is compared. Experimental.
normalize: boolean
Normalize all data? Default: False.
method: tuple
The method name (string) and a dictionary of keywords describing the method will determine the way an overlap integral is computed. Not used yet.
cmap: string
A matplotlib name of colormaps available. The default (‘jet’) will have blue at the low end through green yellow to red.

Input BDPS

Image_BDP: count: 2 or more
Input images (or cubes); for example, from Ingest_AT, LineCube_AT or Moment_AT.

Output BDPs

Image_BDP: count: 1
Parameters: keyval : dictionary, optional

Attributes

 _version (string)

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() Main program for OverlapIntegral 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 from the AT, for merging into the ADMIT Summary object. 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.
run()[source]

Main program for OverlapIntegral

summary()[source]

Returns the summary dictionary from the AT, for merging into the ADMIT Summary object.

Key type Description
overlap list output image and information about lines used
Parameters: None dict Dictionary of SummaryEntry
admit.at.OverlapIntegral_AT.crossn(data, myplot)[source]

Run over all possible cross-correlations between the N input data CAUTION: Expensive routine @todo divide cross(i,j)/sqrt(auto(i)*auto(j))

admit.at.OverlapIntegral_AT.rgb1(r, g, b, normalize=False)[source]
admit.at.OverlapIntegral_AT.rgb2(a, b, jpgname, f=0.5)[source]

Convert 2 2D-numpy arrays into a colorful JPG image f = Color Composition Index RGB = (A, B+f*A, B)

admit.at.OverlapIntegral_AT.rgb3(r, g, b, jpgname)[source]

Convert 3 2D-numpy arrays into a colorful JPG image It needs the PIL module, which CASA doesn’t have but we would like to try this out one of these moons...