|
| ImageConcat (uInt axis, Bool tempClose=True, Bool combineMiscInfo=True) |
| Constructor. More...
|
|
| ImageConcat (const JsonKVMap &, const String &fileName) |
| Construct the object from a Json file with the given name. More...
|
|
| ImageConcat () |
| Default constructor, Sets the concatenation axis to 0. More...
|
|
| ImageConcat (const ImageConcat< T > &other) |
| Copy constructor (reference semantics) More...
|
|
virtual | ~ImageConcat () |
| Destructor. More...
|
|
ImageConcat< T > & | operator= (const ImageConcat< T > &other) |
| Assignment operator (reference semantics) More...
|
|
virtual ImageInterface< T > * | cloneII () const |
| Make a copy of the object (reference semantics). More...
|
|
virtual void | save (const String &fileName) const |
| Save the image in file 'image.concat' in a directory with the given name. More...
|
|
virtual Bool | setMiscInfo (const RecordInterface &newInfo) |
| Replace the miscinfo in the ConcatImage, which writes the image.concat file. More...
|
|
virtual Bool | setImageInfo (const ImageInfo &info) |
| Set the ImageInfo in the super class ImageInterface and in each underlying image. More...
|
|
virtual String | imageType () const |
| Get the image type (returns name of derived class). More...
|
|
virtual Bool | isPersistent () const |
| Is the lattice persistent and can it be loaded by other processes as well? More...
|
|
void | setImage (ImageInterface< T > &image, Bool relax) |
| Sets a new image into the list to be concatenated. More...
|
|
void | setLattice (MaskedLattice< T > &lattice) |
| Add a clone of the lattice to the list to be concatenated. More...
|
|
uInt | nimages () const |
| Return the number of images/lattices set so far. More...
|
|
uInt | axis () const |
| Returns the current concatenation axis (0 relative) More...
|
|
uInt | imageDim () const |
| Returns the number of dimensions of the input images/lattices Returns 0 if none yet set. More...
|
|
ImageInterface< T > & | image (uInt i) const |
| Return a reference to the i-th image. More...
|
|
virtual Bool | lock (FileLocker::LockType, uInt nattempts) |
| Handle the (un)locking and syncing, etc. More...
|
|
virtual void | unlock () |
|
virtual Bool | hasLock (FileLocker::LockType) const |
|
virtual void | resync () |
|
virtual void | flush () |
|
virtual void | tempClose () |
|
virtual void | reopen () |
|
virtual String | name (Bool stripPath=False) const |
| Return the name of the current ImageInterface object. More...
|
|
virtual Bool | isMasked () const |
| Has the object really a mask? More...
|
|
virtual Bool | hasPixelMask () const |
| Does the image have a pixelmask? More...
|
|
virtual const Lattice< Bool > & | pixelMask () const |
| Get access to the pixelmask. More...
|
|
virtual Lattice< Bool > & | pixelMask () |
|
virtual const LatticeRegion * | getRegionPtr () const |
| Get the region used (always returns 0) More...
|
|
virtual Bool | isWritable () const |
| If all of the underlying lattices are writable returns True. More...
|
|
virtual IPosition | shape () const |
| Return the shape of the concatenated image. More...
|
|
virtual IPosition | doNiceCursorShape (uInt maxPixels) const |
| Return the best cursor shape. More...
|
|
virtual Bool | doGetSlice (Array< T > &buffer, const Slicer §ion) |
| Do the actual get of the data. More...
|
|
virtual Bool | doGetMaskSlice (Array< Bool > &buffer, const Slicer §ion) |
| Do the actual get of the mask data. More...
|
|
virtual void | doPutSlice (const Array< T > &sourceBuffer, const IPosition &where, const IPosition &stride) |
| Do the actual put of the data into the Lattice. More...
|
|
virtual void | resize (const TiledShape &) |
| Throws an excpetion as you cannot reshape an ImageConcat object. More...
|
|
virtual Bool | ok () const |
| Check class invariants. More...
|
|
virtual LatticeIterInterface< T > * | makeIter (const LatticeNavigator &navigator, Bool useRef) const |
| These are the implementations of the LatticeIterator letters. More...
|
|
| ImageInterface () |
|
| ImageInterface (const RegionHandler ®ionHandler) |
| Construct for a specific region handler object. More...
|
|
| ImageInterface (const ImageInterface &other) |
| Copy constructor (copy semantics). More...
|
|
virtual | ~ImageInterface () |
|
virtual MaskedLattice< T > * | cloneML () const |
| Make a copy of the derived object (reference semantics). More...
|
|
virtual Bool | setUnits (const Unit &newUnits) |
| Function which get and set the units associated with the image pixels (i.e. More...
|
|
virtual const Unit & | units () const |
|
virtual Bool | setCoordinateInfo (const CoordinateSystem &coords) |
| Functions to set or replace the coordinate information in the Image Returns False on failure, e.g. More...
|
|
const CoordinateSystem & | coordinates () const |
|
virtual LELCoordinates | lelCoordinates () const |
| Function to get a LELCoordinate object containing the coordinates. More...
|
|
LoggerHolder & | logger () |
| Get access to the LoggerHolder. More...
|
|
const LoggerHolder & | logger () const |
|
LogIO & | logSink () |
| Allow messages to be logged to this ImageInterface. More...
|
|
const LogIO & | logSink () const |
|
void | appendLog (const LoggerHolder &other) |
| Add the messages from the other image logger to this one. More...
|
|
const TableRecord & | miscInfo () const |
| Often we have miscellaneous information we want to attach to an image. More...
|
|
const ImageInfo & | imageInfo () const |
| The ImageInfo object contains some miscellaneous information about the image which unlike that stored in MiscInfo, has a standard list of things, such as the restoring beam. More...
|
|
ImageInfo & | rwImageInfo () |
| Get non-const access to the ImageInfo. More...
|
|
virtual ImageAttrHandler & | attrHandler (Bool createHandler=False) |
| Get access to the attribute handler. More...
|
|
ImageAttrHandler & | roAttrHandler () const |
|
Bool | canDefineRegion () const |
| Can the image handle region definition? More...
|
|
virtual ImageRegion | makeMask (const String &name, Bool defineAsRegion=True, Bool setAsDefaultMask=True, Bool initialize=False, Bool value=True) |
| Make a mask which is suitable for the type of image. More...
|
|
virtual void | defineRegion (const String &name, const ImageRegion ®ion, RegionHandler::GroupType, Bool overwrite=False) |
| Define a region/mask belonging to the image. More...
|
|
virtual Bool | hasRegion (const String ®ionName, RegionHandler::GroupType=RegionHandler::Any) const |
| Does the image have a region with the given name? More...
|
|
virtual ImageRegion * | getImageRegionPtr (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True) const |
| Get a region/mask belonging to the image from the given group (which can be Any). More...
|
|
virtual void | renameRegion (const String &newName, const String &oldName, RegionHandler::GroupType=RegionHandler::Any, Bool overwrite=False) |
| Rename a region. More...
|
|
virtual void | removeRegion (const String &name, RegionHandler::GroupType=RegionHandler::Any, Bool throwIfUnknown=True) |
| Remove a region/mask belonging to the image from the given group (which can be Any). More...
|
|
virtual Vector< String > | regionNames (RegionHandler::GroupType=RegionHandler::Any) const |
| Get the names of all regions/masks. More...
|
|
virtual void | useMask (MaskSpecifier=MaskSpecifier()) |
| Use the mask as specified. More...
|
|
virtual void | setDefaultMask (const String ®ionName) |
| Set the default pixelmask to the mask with the given name (which has to exist in the "masks" group). More...
|
|
virtual String | getDefaultMask () const |
| Get the name of the default pixelmask. More...
|
|
ImageRegion | getRegion (const String ®ionName, RegionHandler::GroupType=RegionHandler::Any) const |
| Get a region belonging to the image. More...
|
|
String | makeUniqueRegionName (const String &rootName, uInt startNumber=1) const |
| Make a unique region name from the given root name, thus make it such that the name is not already in use for a region or mask. More...
|
|
Bool | toRecord (String &error, RecordInterface &outRec) |
| Save and restore an ImageInterface object to or from a state Record. More...
|
|
Bool | fromRecord (String &error, const RecordInterface &inRec) |
|
template<class T>
class casacore::ImageConcat< T >
Concatenates images along a specified axis
Intended use:
Public interface
Review Status
- Date Reviewed:
- yyyy/mm/dd
Prerequisite
Etymology
This is a class designed to concatenate images along a specified axis
Synopsis
This is a class designed to concatenate images along a specified axis. This means you can join them together. E.g., join images of shape [10,20,30] and [10,20,40] into a lattice of shape [10,20,70].
The ImageConcat object does not copy the input images, it just references them. You can use the Lattice<T>::copyData(Lattice<T>) function to fill an output image with the concatenated input images
If you use the putSlice function, be aware that it will change the underlying images if they are writable.
You can also concatenate a lattice to an image.
Example
IPosition
shape(2, 10, 20);
"tImageConcat_tmp1.img");
im1.set(1.0);
"tImageConcat_tmp2.img");
im2.set(2.0);
ImageConcat<Float> concat(0);
concat.setImage(im1,
True);
concat.setImage(im2,
True);
"tImageConcat_tmp3.img");
im3.copyData(concat);
See tImageConcat.cc for more examples.
Motivation
Image concatentation is a useful enduser requirement.
To Do
-
Offer the ability to increase the dimensionality of the output image
Definition at line 126 of file ImageConcat.h.