R3DFrame Class Reference

#include <R3D/Common/R3DFrame.h>

List of all members.


Detailed Description

Class that holds information about a tile from the complete mosaic.

The history of this is that a frame was being represented in a backward lefthanded coordinate system where the origin was in the upper left which gave rise to the variable naming.

Author:
Michael A. Jackson for BlueQuartz Software
Date:
May 29, 2009
Version:
1.0


Public Member Functions

void setAll (float xMin, float yMin, float xMax, float yMax)
 Sets all the values.
bool intersects (R3DFrame::Pointer frame)
 Does this frame have an intersection with the supplied frame object.
R3DFrame::Pointer getIntersection (R3DFrame::Pointer f)
 Returns the frame object that represents the intersection between the 2 frames.
void copy (R3DFrame::Pointer copyFrom)
 creates a copy of this frame into another R3DFrame object
float getWidth ()
 Returns the width of the frame.
float getHeight ()
 Returns the height of the frame.
void getSize (float size[2])
 Retrieves the size of frame.
void getOrigin (float origin[2])
 Retrieves the origin of the frame.
void printSelf (std::ostream &out)
 Outputs some debugging information for this object.

Static Public Member Functions

static R3DFrame::Pointer New (float xMin, float yMin, float xMax, float yMax)
 Static constructor used to create and initialize an instance of this class.
static R3DFrame::Pointer New (R3DFrame::Pointer frame)
 Creates a new R3DFrame from the values of the supplied object.
static R3DFrame::Pointer ComputeNormalizedCoords (R3DFrame::Pointer intersectedFrameMicrons, R3DFrame::Pointer frameRectMicrons, float scalingFactor[2])
 Computes some special coordinates for use in some algorithms.


Member Function Documentation

R3DFrame::Pointer R3DFrame::New ( float  xMin,
float  yMin,
float  xMax,
float  yMax 
) [static]

Static constructor used to create and initialize an instance of this class.

Parameters:
xMin Minimum x value (Left)
yMin Minimum y value (Top)
xMax Maximum x value (Right)
yMax Maximum y value (Bottom)
Returns:

R3DFrame::Pointer R3DFrame::New ( R3DFrame::Pointer  frame  )  [static]

Creates a new R3DFrame from the values of the supplied object.

Parameters:
frame Object to copy values from
Returns:
Shared Pointer

R3DFrame::Pointer R3DFrame::ComputeNormalizedCoords ( R3DFrame::Pointer  intersectedFrameMicrons,
R3DFrame::Pointer  frameRectMicrons,
float  scalingFactor[2] 
) [static]

Computes some special coordinates for use in some algorithms.

Parameters:
intersectedFrameMicrons Intersected Frame
frameRectMicrons R3DFrame object
scalingFactor Scaling factor for the slice/tile/data set
Returns:

void R3DFrame::setAll ( float  xMin,
float  yMin,
float  xMax,
float  yMax 
)

Sets all the values.

Parameters:
xMin Minimum x value (Left)
yMin Minimum y value (Top)
xMax Maximum x value (Right)
yMax Maximum y value (Bottom)

bool R3DFrame::intersects ( R3DFrame::Pointer  frame  ) 

Does this frame have an intersection with the supplied frame object.

Parameters:
frame The frame to test for intersection with this frame
Returns:
True if the 2 frames intersect.

R3DFrame::Pointer R3DFrame::getIntersection ( R3DFrame::Pointer  f  ) 

Returns the frame object that represents the intersection between the 2 frames.

Parameters:
f The frame to test for intersection
Returns:
Non-Null shared pointer if there is an intersection. Use frame.get() != NULL in your code.

void R3DFrame::copy ( R3DFrame::Pointer  copyFrom  ) 

creates a copy of this frame into another R3DFrame object

Parameters:
copyFrom The object to copy from.

float R3DFrame::getWidth (  ) 

Returns the width of the frame.

Returns:

float R3DFrame::getHeight (  ) 

Returns the height of the frame.

Returns:

void R3DFrame::getSize ( float  size[2]  ) 

Retrieves the size of frame.

Parameters:
size Value to store the size into

void R3DFrame::getOrigin ( float  origin[2]  ) 

Retrieves the origin of the frame.

Parameters:
origin The value to store the origin into

void R3DFrame::printSelf ( std::ostream &  out  ) 

Outputs some debugging information for this object.

Parameters:
out the std::ostream to write the inforation


The documentation for this class was generated from the following files:
Generated on Fri Aug 28 14:04:33 2009 for R3DImageTools by  doxygen 1.5.2