PSImageBodyC - This is the body class for PSImageC

User Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

BodyRefCounterC

StdConstC

Variables:

Methods:

PSImageBodyC(): Default constructor.
PSImageBodyC(const FilenameC & output,const ImageRectangleC & rect,UIntT subsample = 1,UIntT subs_offset = 0): See PSImageC handle class for documentation
PSImageBodyC(OStreamC & output,const ImageRectangleC & rect,UIntT subsample = 1,UIntT subs_offset = 0)
~PSImageBodyC(): Destructor
void SetSizeMm(RealT size): set Postscript window width in mm; default = rect.Cnum() * (25.4/72) mm (roughly)
void SetFont(const StringC & name,IntT size): Set the font to use.
Default is helvetica 12 point.
void Title(const StringC & title): Set the title that will appear on the ghostview title bar
void Normalize(): Normalise the size of all fields of symbols that are printed subsequently
Size of largest symbol will be "subsample" pixels (unless subsequently rescaled).
RealT PrintArrows(const NumImageC<Vector2dC> & vecs,const RealT scale = 1.0): Print grid of 2D vectors as arrows rescaled by factor of "scale"
The normalisation factor (if computed) is returned.
RealT PrintEllipses(const NumImageC<Matrix2d2C> & covs,const RealT scale = 1.0): Print grid of 2x2 symmetric matrices as "covariance" ellipses rescaled by factor of "scale"
The normalisation factor (if computed) is returned.
void PrintCircles(const ImageC<RealT> & value,const RealT scale = 1.0): Print grid of circles of diameter given by "value"
rescaled by factor of "scale"
void PrintImage(const ImageC<ByteT> & im): Print background greyscale image
void PrintImage(const ImageC<ByteRGBValueC> & im): Print background colour image
void DrawLine(const Point2dC & from,const Point2dC & to): Draw a line.
void DrawArrow(const Point2dC & at,const Vector2dC & vec): Draw a vector "vec" as an arrow, starting from "at".
void DrawEllipse(const Point2dC & at,const Matrix2d2C & mat): Draw a covariance matrix as an ellipse, centered on "at".
void DrawText(const Point2dC & at,const StringC & text): Print some text at a given location.
Use SetFont(...), to control the size and font used for text.
void DrawBorder(): Draw a border round the bounding box
void SetPenColour(RealT r,RealT g,RealT b): Set pen colour.
r,g and b can take values between 0 and 1 where 1,1,1 is white and 0,0,0 is black. Values outside the range will be cliped to the nearest legal value.
void NewPage(): Start a new page.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Bill Christmas, Documentation by CxxDoc: Tue Mar 20 10:48:08 2001

PSImageBodyC

This is the body class for PSImageC

include	"amma/PSImage.hh"
User Level:	Default
Library:	Ccompimg
Example:	exPsIm.cc exPSDraw.cc
Section:	Geometry.2-D Image.Image Processing
In Scope:	std