casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
casa::QtWCBox Class Reference

#include <QtWCBox.h>

Inheritance diagram for casa::QtWCBox:
casacore::WCRegion

Public Member Functions

 QtWCBox ()
 
 QtWCBox (const casacore::Vector< casacore::Quantum< casacore::Double > > &blc, const casacore::Vector< casacore::Quantum< casacore::Double > > &trc, const DisplayCoordinateSystem &cSys, const casacore::Vector< casacore::Int > &absRel)
 Construct from vectors of world coordinates defining the box corners. More...
 
 QtWCBox (const casacore::Vector< casacore::Quantum< casacore::Double > > &blc, const casacore::Vector< casacore::Quantum< casacore::Double > > &trc, const casacore::IPosition &pixelAxes, const DisplayCoordinateSystem &cSys, const casacore::Vector< casacore::Int > &absRel)
 Construct from vectors of world coordinates defining the box corners. More...
 
 QtWCBox (const casacore::LCRegion &region, const DisplayCoordinateSystem &cSys)
 Construct from the bounding box of an casacore::LCRegion. More...
 
 QtWCBox (const QtWCBox &other)
 Copy constructor (reference semantics [except for DisplayCoordinateSystem]) More...
 
virtual ~QtWCBox ()
 Destructor. More...
 
QtWCBoxoperator= (const QtWCBox &other)
 Assignment (copy semantics) More...
 
virtual casacore::Bool operator== (const casacore::WCRegion &other) const
 Comparison. More...
 
virtual casacore::WCRegioncloneRegion () const
 Clone a QtWCBox object. More...
 
virtual casacore::Bool canExtend () const
 QtWCBox can extend a region. More...
 
QtWCBox splitBox (const casacore::IPosition &axes) const
 Make a new box from the given axesin this box. More...
 
virtual casacore::LCRegiondoToLCRegion (const casacore::CoordinateSystem &cSys, const casacore::IPosition &latticeShape, const casacore::IPosition &pixelAxesMap, const casacore::IPosition &outOrder) const
 Convert to an casacore::LCRegion using the supplied DisplayCoordinateSystem and shape. More...
 
virtual casacore::TableRecord toRecord (const casacore::String &tableName) const
 Convert the QtWCBox object to a record. More...
 
virtual casacore::String type () const
 Return region type. More...
 
casacore::String toBoxString () const
 Convert from/to boxit format string. More...
 
void setChanExt (const casacore::Double, const casacore::Double)
 FIXME: refactor to someplace more appropriate get/set chan extension. More...
 
casacore::Bool getChanExt (casacore::Double &, casacore::Double &)
 
void setPolExt (const casacore::Double, const casacore::Double)
 FIXME: refactor to someplace more appropriate get/set pol extension. More...
 
casacore::Bool getPolExt (casacore::Double &, casacore::Double &)
 
- Public Member Functions inherited from casacore::WCRegion
 WCRegion ()
 
 WCRegion (const WCRegion &other)
 Copy constructor (copy semantics). More...
 
virtual ~WCRegion ()
 Destructor. More...
 
Bool operator!= (const WCRegion &other) const
 
virtual uInt ndim () const
 Get the dimensionality (i.e. More...
 
const RecordgetAxesDesc () const
 Get the description of all axes. More...
 
const RecordgetAxisDesc (uInt axis) const
 Get the description of the given axis. More...
 
Int axisNr (const Record &desc, const Record &axesDesc) const
 Return the axis number of the description of an axis in the full axes description. More...
 
Bool isAxisDescEqual (const Record &desc1, const Record &desc2) const
 Are both axis descriptions equal? More...
 
const Stringcomment () const
 Get or set the comment. More...
 
void setComment (const String &comment)
 
virtual LCRegiontoLCRegion (const CoordinateSystem &cSys, const IPosition &shape) const
 Convert to an LCRegion using the given new coordinate system and shape. More...
 
LCRegiontoLCRegionAxes (const CoordinateSystem &cSys, const IPosition &shape, const IPosition &pixelAxesMap, const IPosition &outOrder) const
 Convert to an LCRegion using the given coordinate system and shape. More...
 
void defineRecordFields (RecordInterface &record, const String &className) const
 Define the type and class name in the record. More...
 

Static Public Member Functions

static QtWCBoxfromRecord (const casacore::TableRecord &rec, const casacore::String &tableName)
 Convert to a QtWCBox from a record. More...
 
static casacore::String className ()
 Returns QtWCBox. More...
 
static QtWCBoxfromBoxString (const casacore::String &, const DisplayCoordinateSystem &cSys, casacore::String &err)
 
static void unitInit ()
 
- Static Public Member Functions inherited from casacore::WCRegion
static WCRegionfromRecord (const TableRecord &rec, const String &tableName)
 Convert correct object from a record. More...
 

Private Member Functions

void checkUnits (const casacore::IPosition &pixelAxes, const casacore::Vector< casacore::Quantum< casacore::Double > > &values, const DisplayCoordinateSystem &cSys)
 Check units of quanta are consistent with DisplayCoordinateSystem. More...
 
void convertPixel (casacore::Double &pixel, const casacore::Quantum< casacore::Double > &value, const casacore::Int absRel, const casacore::Double refPix, const casacore::Int shape, const casacore::Bool isBlc) const
 Convert relative pixels to absolute or fill in defaults. More...
 

Private Attributes

casacore::Vector
< casacore::Quantum
< casacore::Double > > 
itsBlc
 
casacore::Vector
< casacore::Quantum
< casacore::Double > > 
itsTrc
 
casacore::IPosition itsPixelAxes
 
DisplayCoordinateSystem itsCSys
 
casacore::Vector< casacore::IntitsAbsRel
 
casacore::Bool itsNull
 

Additional Inherited Members

- Protected Member Functions inherited from casacore::WCRegion
WCRegionoperator= (const WCRegion &other)
 Assignment (copy semantics) makes only sense for a derived class. More...
 
void addAxisDesc (const Record &axisDesc)
 Add an axis with its description. More...
 
Record makeAxisDesc (const CoordinateSystem &cSys, uInt pixelAxis) const
 Make a description of a pixel axis in the coordinate system. More...
 
Record makeAxesDesc (const CoordinateSystem &cSys) const
 Make a description of all pixel axes in the coordinate system (in pixel axes order). More...
 
void makeWorldAbsolute (Vector< Double > &world, const Vector< Int > &absRel, const CoordinateSystem &cSys, const IPosition &shape) const
 Convert relative to absolute world as needed. More...
 
void checkAxes (const IPosition &pixelAxes, const CoordinateSystem &cSys, const Vector< String > &quantityUnits) const
 
- Static Protected Member Functions inherited from casacore::WCRegion
static void unitInit ()
 
static void convertPixel (Double &pixel, const Double &value, const String &unit, const Int absRel, const Double refPix, const Int shape)
 

Detailed Description

Definition at line 52 of file QtWCBox.h.

Constructor & Destructor Documentation

casa::QtWCBox::QtWCBox ( )
casa::QtWCBox::QtWCBox ( const casacore::Vector< casacore::Quantum< casacore::Double > > &  blc,
const casacore::Vector< casacore::Quantum< casacore::Double > > &  trc,
const DisplayCoordinateSystem cSys,
const casacore::Vector< casacore::Int > &  absRel 
)

Construct from vectors of world coordinates defining the box corners.

It is assumed that the order of the values is in the order of the pixel axes in the given coordinate system.

casa::QtWCBox::QtWCBox ( const casacore::Vector< casacore::Quantum< casacore::Double > > &  blc,
const casacore::Vector< casacore::Quantum< casacore::Double > > &  trc,
const casacore::IPosition pixelAxes,
const DisplayCoordinateSystem cSys,
const casacore::Vector< casacore::Int > &  absRel 
)

Construct from vectors of world coordinates defining the box corners.

You specify the pixel axis order of the world values.

casa::QtWCBox::QtWCBox ( const casacore::LCRegion region,
const DisplayCoordinateSystem cSys 
)

Construct from the bounding box of an casacore::LCRegion.

casa::QtWCBox::QtWCBox ( const QtWCBox other)

Copy constructor (reference semantics [except for DisplayCoordinateSystem])

virtual casa::QtWCBox::~QtWCBox ( )
virtual

Destructor.

Member Function Documentation

virtual casacore::Bool casa::QtWCBox::canExtend ( ) const
virtual

QtWCBox can extend a region.

Reimplemented from casacore::WCRegion.

void casa::QtWCBox::checkUnits ( const casacore::IPosition pixelAxes,
const casacore::Vector< casacore::Quantum< casacore::Double > > &  values,
const DisplayCoordinateSystem cSys 
)
private

Check units of quanta are consistent with DisplayCoordinateSystem.

static casacore::String casa::QtWCBox::className ( )
static

Returns QtWCBox.

virtual casacore::WCRegion* casa::QtWCBox::cloneRegion ( ) const
virtual

Clone a QtWCBox object.

Implements casacore::WCRegion.

void casa::QtWCBox::convertPixel ( casacore::Double pixel,
const casacore::Quantum< casacore::Double > &  value,
const casacore::Int  absRel,
const casacore::Double  refPix,
const casacore::Int  shape,
const casacore::Bool  isBlc 
) const
private

Convert relative pixels to absolute or fill in defaults.

virtual casacore::LCRegion* casa::QtWCBox::doToLCRegion ( const casacore::CoordinateSystem cSys,
const casacore::IPosition latticeShape,
const casacore::IPosition pixelAxesMap,
const casacore::IPosition outOrder 
) const
virtual

Convert to an casacore::LCRegion using the supplied DisplayCoordinateSystem and shape.

Implements casacore::WCRegion.

static QtWCBox* casa::QtWCBox::fromBoxString ( const casacore::String ,
const DisplayCoordinateSystem cSys,
casacore::String err 
)
static
static QtWCBox* casa::QtWCBox::fromRecord ( const casacore::TableRecord rec,
const casacore::String tableName 
)
static

Convert to a QtWCBox from a record.

casacore::Bool casa::QtWCBox::getChanExt ( casacore::Double ,
casacore::Double  
)
casacore::Bool casa::QtWCBox::getPolExt ( casacore::Double ,
casacore::Double  
)
QtWCBox& casa::QtWCBox::operator= ( const QtWCBox other)

Assignment (copy semantics)

virtual casacore::Bool casa::QtWCBox::operator== ( const casacore::WCRegion other) const
virtual

Comparison.

Reimplemented from casacore::WCRegion.

void casa::QtWCBox::setChanExt ( const casacore::Double  ,
const casacore::Double   
)

FIXME: refactor to someplace more appropriate get/set chan extension.

void casa::QtWCBox::setPolExt ( const casacore::Double  ,
const casacore::Double   
)

FIXME: refactor to someplace more appropriate get/set pol extension.

QtWCBox casa::QtWCBox::splitBox ( const casacore::IPosition axes) const

Make a new box from the given axesin this box.

casacore::String casa::QtWCBox::toBoxString ( ) const

Convert from/to boxit format string.

virtual casacore::TableRecord casa::QtWCBox::toRecord ( const casacore::String tableName) const
virtual

Convert the QtWCBox object to a record.

The record can be used to make the object persistent. The tableName argument can be used by derived classes (e.g. casacore::LCPagedMask) to put very large objects.

Implements casacore::WCRegion.

virtual casacore::String casa::QtWCBox::type ( ) const
virtual

Return region type.

Returns the class name

Implements casacore::WCRegion.

static void casa::QtWCBox::unitInit ( )
static

Member Data Documentation

casacore::Vector<casacore::Int> casa::QtWCBox::itsAbsRel
private

Definition at line 148 of file QtWCBox.h.

casacore::Vector<casacore::Quantum<casacore::Double> > casa::QtWCBox::itsBlc
private

Definition at line 144 of file QtWCBox.h.

DisplayCoordinateSystem casa::QtWCBox::itsCSys
private

Definition at line 147 of file QtWCBox.h.

casacore::Bool casa::QtWCBox::itsNull
private

Definition at line 149 of file QtWCBox.h.

casacore::IPosition casa::QtWCBox::itsPixelAxes
private

Definition at line 146 of file QtWCBox.h.

casacore::Vector<casacore::Quantum<casacore::Double> > casa::QtWCBox::itsTrc
private

Definition at line 145 of file QtWCBox.h.


The documentation for this class was generated from the following file: