Getting Started

Documentation

Glish

Learn More

Programming

Contact Us

Version 1.9 Build 1556

News	FAQ
Search	Home

componentlist - Tool

	Package	synthesis
	Module	componentmodels

Postscript file available

A tool for the manipulation of groups of components

include "componentlist.g"

Description
A componentlist is a tool that contains functions that manipulate components. A component is a functional representation of the sky brightness and is described in more detail in the overview of this module. The simplest way to make a componentlist tool is to use the emptycomponentlist constructor. This creates a componentlist tool that does not contain any components and is not associated with any file. The alternative is to use either the componentlist or asciitocomponentlist constructors. These create a componentlist tool by reading the data from an AIPS++ table or a properly formatted ascii file. The simplest way to add components to a list is to use the simulate function. The components that are added to the list can then be edited using the component editor, or any of the manipulate functions like setshape or setrefdir.

Constructors

asciitocomponentlist	Create a componentlist from an ascii file
componentlist	Construct an componentlist from the data in an AIPS++ table
emptycomponentlist	Construct an empty componentlist

Functions

add	Add a component to the list.
addcomponent	Add a component to the list
close	Save the componentlist to disk and reset its state.
component	Extract a component from the list.
concatenate	Append components from another componentlist.
convertfluxpol	Change (convert) the polarization representation of the specified components
convertfluxunit	Change (convert) the flux units of the specified components
convertfrequnit	Convert the reference frequency to a new unit
convertrefdir	Convert the reference direction to a new frame
convertshape	Change the units of the shape parameters
deselect	Unmark components in the list
done	Delete the componentlist tool
edit	Start up the component editor gui
getfluxerror	Get the error in the flux of the specified component
getfluxpol	Get the polarization representation for the flux of the specified component
getfluxunit	Get the flux unit of the specified component
getfluxvalue	Get the flux value of the specified component
getfreq	Get the reference frequency
getfreqframe	Get the reference frequency frame
getfrequnit	Get the reference frequency unit
getfreqvalue	Get the reference frequency value
getlabel	Get the label of the specified component
getrefdir	Return the reference direction
getrefdirdec	Get the declination of the reference direction.
getrefdirframe	Get the reference frame of the reference direction.
getrefdirra	Get the RA of the reference direction.
getshape	Return the shape parameters the component
getspectrum	Return the spectral parameters the component
indices	Return a vector of indices.
is_physical	Check if a component is physically plausible
length	Find the number of components in the list.
print	Summarize the specified component to the logger
purge	Permanently delete removed components.
recover	Obtain removed components.
remove	Remove a component from the list.
rename	Give the list a name so it can save itself.
replace	Replace components in the list.
sample	Sample the flux of the list in a specified direction.
select	Mark components in the list
selected	Determine which components are selected
setflux	Set the flux of the specified components
setfreq	Set the reference frequency
setfreqframe	Set the reference frame for the frequency
setlabel	Set the label of the specified components
setrefdir	Set the reference direction
setrefdirframe	Set the reference frame for the direction
setshape	Change the shape of the component
setspectrum	Change the spectrum of the component
shapetype	Returns the shape type of the component
simulate	Add some simulated components to the list
sort	Sort the components in a list
spectrumtype	Returns the spectral shape of the component