Loading...
Searching...
No Matches
LCExtension.h
Go to the documentation of this file.
//# LCExtension.h: Extend an LCRegion along straight lines to other dimensions
//# Copyright (C) 1998,2001
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef LATTICES_LCEXTENSION_H
#define LATTICES_LCEXTENSION_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/lattices/LRegions/LCRegionMulti.h>
#include <casacore/lattices/LRegions/LCBox.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Extend an LCRegion along straight lines to other dimensions
// </summary>
// <use visibility=export>
// <reviewed reviewer="" date="" tests="">
// </reviewed>
// <prerequisite>
// <li> <linkto class=LCRegion>LCRegion</linkto>
// </prerequisite>
// <synopsis>
// The LCExtension class is a specialization of class
// <linkto class=LCRegion>LCRegion</linkto>.
// It makes it possible to extend a LCRegion along straight lines to
// other dimensions. E.g. a circle in the xy-plane can be extended to
// a cylinder in the xyz-space.
// It can be used for a lattice of any dimensionality as long as the
// dimensionality of the (hyper-)extension matches the dimensionality of
// the lattice.
// </synopsis>
// <example>
// <srcblock>
// </srcblock>
// </example>
// <todo asof="1997/11/11">
// <li> Extend along (slanted) cone lines
// </todo>
class LCExtension: public LCRegionMulti
{
public:
LCExtension();
// Extend the given region along axes as given by <src>extendAxes</src>
// from the bottom left corner (blc) to the top right corner (trc)
// as given by <src>extendBox</src>.
// Every kind of box (absolute, relative, fractional, unspecified)
// can be used to define the extension blc and trc.
// The sum of the dimensionality of the region and the extend box
// make up the dimensionality of the LCExtension region.
// Similarly the lattice shapes in region and box are combined.
// <br>
// The second version takes over the pointer when the switch is true.
// <group>
LCExtension (const LCRegion& region,
const IPosition& extendAxes,
const LCBox& extendBox);
LCExtension (Bool takeOver,
const LCRegion* region,
const IPosition& extendAxes,
const LCBox& extendBox);
// </group>
// Copy constructor (copy semantics).
LCExtension (const LCExtension& other);
virtual ~LCExtension();
// Assignment (copy semantics).
LCExtension& operator= (const LCExtension& other);
// Comparison
virtual Bool operator== (const LCRegion& other) const;
// Make a copy of the derived object.
virtual LCRegion* cloneRegion() const;
// Get the original region.
const LCRegion& region() const;
// Get the extend axes.
const IPosition& extendAxes() const;
// Get the extend box.
const LCBox& extendBox() const;
// Get the class name (to store in the record).
static String className();
// Get the region type. Returns the class name.
virtual String type() const;
// Convert the (derived) object to a record.
virtual TableRecord toRecord (const String& tableName) const;
// Convert correct object from a record.
static LCExtension* fromRecord (const TableRecord&,
const String& tableName);
protected:
// Construct another LCRegion (for e.g. another lattice) by moving
// this one. It recalculates the bounding box and mask.
// A positive translation value indicates "to right".
virtual LCRegion* doTranslate (const Vector<Float>& translateVector,
const IPosition& newLatticeShape) const;
// Do the actual getting of the mask.
virtual void multiGetSlice (Array<Bool>& buffer, const Slicer& section);
// This function is needed here because the niceCursorShape of the
// contributing region does not make any sense (other dimensionality).
virtual IPosition doNiceCursorShape (uInt maxPixels) const;
private:
// Fill the object.
// <group>
void fillRegionAxes();
void fill (const IPosition& stretchAxes, const LCBox& stretchBox);
// </group>
IPosition itsExtendAxes;
IPosition itsRegionAxes;
LCBox itsExtendBox;
};
inline const LCRegion& LCExtension::region() const
{
return *(regions()[0]);
}
inline const IPosition& LCExtension::extendAxes() const
{
return itsExtendAxes;
}
inline const LCBox& LCExtension::extendBox() const
{
return itsExtendBox;
}
} //# NAMESPACE CASACORE - END
#endif
casacore::Array
Definition Array.h:155
casacore::IPosition
Definition IPosition.h:117
casacore::LCBox
Definition LCBox.h:66
casacore::LCExtension::cloneRegion
virtual LCRegion * cloneRegion() const
Make a copy of the derived object.
casacore::LCExtension::operator==
virtual Bool operator==(const LCRegion &other) const
Comparison.
casacore::LCExtension::~LCExtension
virtual ~LCExtension()
casacore::LCExtension::doNiceCursorShape
virtual IPosition doNiceCursorShape(uInt maxPixels) const
This function is needed here because the niceCursorShape of the contributing region does not make any...
casacore::LCExtension::multiGetSlice
virtual void multiGetSlice(Array< Bool > &buffer, const Slicer &section)
Do the actual getting of the mask.
casacore::LCExtension::itsRegionAxes
IPosition itsRegionAxes
Definition LCExtension.h:153
casacore::LCExtension::itsExtendBox
LCBox itsExtendBox
Definition LCExtension.h:154
casacore::LCExtension::doTranslate
virtual LCRegion * doTranslate(const Vector< Float > &translateVector, const IPosition &newLatticeShape) const
Construct another LCRegion (for e.g.
casacore::LCExtension::LCExtension
LCExtension(const LCRegion &region, const IPosition &extendAxes, const LCBox &extendBox)
Extend the given region along axes as given by extendAxes from the bottom left corner (blc) to the to...
casacore::LCExtension::LCExtension
LCExtension(Bool takeOver, const LCRegion *region, const IPosition &extendAxes, const LCBox &extendBox)
casacore::LCExtension::toRecord
virtual TableRecord toRecord(const String &tableName) const
Convert the (derived) object to a record.
casacore::LCExtension::LCExtension
LCExtension(const LCExtension &other)
Copy constructor (copy semantics).
casacore::LCExtension::region
const LCRegion & region() const
Get the original region.
Definition LCExtension.h:158
casacore::LCExtension::operator=
LCExtension & operator=(const LCExtension &other)
Assignment (copy semantics).
casacore::LCExtension::fromRecord
static LCExtension * fromRecord(const TableRecord &, const String &tableName)
Convert correct object from a record.
casacore::LCExtension::fillRegionAxes
void fillRegionAxes()
Fill the object.
casacore::LCExtension::itsExtendAxes
IPosition itsExtendAxes
Definition LCExtension.h:152
casacore::LCExtension::className
static String className()
Get the class name (to store in the record).
casacore::LCExtension::extendBox
const LCBox & extendBox() const
Get the extend box.
Definition LCExtension.h:166
casacore::LCExtension::type
virtual String type() const
Get the region type.
casacore::LCExtension::extendAxes
const IPosition & extendAxes() const
Get the extend axes.
Definition LCExtension.h:162
casacore::LCExtension::LCExtension
LCExtension()
casacore::LCExtension::fill
void fill(const IPosition &stretchAxes, const LCBox &stretchBox)
casacore::LCRegionMulti::regions
const Block< const LCRegion * > & regions() const
Get the contributing regions.
Definition LCRegionMulti.h:169
casacore::LCRegionMulti::LCRegionMulti
LCRegionMulti()
casacore::LCRegion
Definition LCRegion.h:86
casacore::Slicer
Definition Slicer.h:287
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::TableRecord
Definition TableRecord.h:183
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::uInt
unsigned int uInt
Definition aipstype.h:49
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40