ImageInfo Struct Reference

Structure for storing information about images or curves. More...

#include <image_info.h>

Public Member Functions
	ImageInfo ()
	ImageInfo (const ImageInfo &rhs)
	~ImageInfo ()
ImageInfo &	operator= (const ImageInfo &rhs)
void	Empty ()
	return to original state after construction
ImageInfo &	operator+= (ImageInfo &rhs)
unsigned long	getNimagePoints ()
	returns number of points currently in the image
KappaType	aveTimeDelay ()
	Computes the time delay averaged over the image.
KappaType	aveInvMag ()
	Computes the inverse magnification averaged over the image, WARNING: This is not always a good measure of the magnification. It is often better to use ImageInfo::area and the orginial size of the source near or do a flux waited average.
RAY	closestRay (const Point_2d &y)
	finds the ray in the image that is closest to the point y on the source plane
Point *	closestPoint (const Point_2d &y)
	finds the point in the image that is closest to the point y on the source plane
RAY	highestSurfaceBrightnessRay ()
	finds the ray in the image that has the highest surface brightness
void	PrintImageInfo ()
	Print information about the image.
void	copy (const ImageInfo &image, bool copykists=true)
	Copy all information about the image including making copies of the imagekist, innerborder and outerborder. Previous information in the image will be.
bool	IsMergedImages ()
	returns true if image is the merger of two or more images of opposite parity
void	ArcInfo (PosType *area, PosType *area_circ, PosType theta)
	Treating the image as an arc, find its parameters, THIS HAS NOT BEEN FINISHED YET!!!
void	FindArc (PosType &radius, PosType *xc, PosType *arc_c, PosType &arclength, PosType &width, PosType resolution, PosType threshold)
	Treating the image as an arc, find its parameters, THIS HAS NOT BEEN FINISHED YET!!!
bool	constant (LensingVariable lenvar, PosType tol)
	checks if all the points within the image have the same lensvar with the tolarence
PosType	ConcaveHullImageArea (bool useborder)
	Area of the image using the concave hull of the points on the image plane.
PosType	ConcaveHullSourceArea (bool useborder)
	Area of the image using the concave hull of the points on the image plane.

Public Attributes
Kist< Point > *	imagekist
	Array of points in image, SHOULD NOT BE USED IN FAVOR OF imagekist! Still used by caustic finding routines.
PosType	gridrange [3]
	gridrange[2] minimum grid size in image, gridrange[0] maximum grid size in outerborder, gridrange[1] maximum grid size in image
PosType	centroid [2]
	Centroid of image.
PosType	area
	area of image or, when using map_images(), the total brightness of the image
PosType	area_error
	error on the estimate of area
Kist< Point > *	innerborder
	the points on the inner border of the image
Kist< Point > *	outerborder
	the points on the outer border of the image, i.e. not in the image
short	ShouldNotRefine
	Flag for stopping refinement but also used for other temporary purposes.
GATE	uniform_mag
	Flag for showing when the distortion of an image can be considered linear.

Detailed Description

Structure for storing information about images or curves.

Constructor & Destructor Documentation

ImageInfo()

ImageInfo::ImageInfo

(

)

Make an array of imageinfo types.

~ImageInfo()

ImageInfo::~ImageInfo

(

)

Destructor of imageinfo types.

Member Function Documentation

ArcInfo()

void ImageInfo::ArcInfo	(	PosType *	area,
		PosType *	area_circ,
		PosType	theta )

Treating the image as an arc, find its parameters, THIS HAS NOT BEEN FINISHED YET!!!

Parameters

area	area of image with surface brightness limit
area_circ	4 * area / circumference^2 of the image, a measure of thinness

aveInvMag()

KappaType ImageInfo::aveInvMag

(

)

Computes the inverse magnification averaged over the image, WARNING: This is not always a good measure of the magnification. It is often better to use ImageInfo::area and the orginial size of the source near or do a flux waited average.

Computes the inverse magnification averaged over the image.

closestPoint()

Point * ImageInfo::closestPoint

(

const Point_2d &

y

)

finds the point in the image that is closest to the point y on the source plane

Find the losest ray within the image to the source point y.

closestRay()

RAY ImageInfo::closestRay

(

const Point_2d &

y

)

finds the ray in the image that is closest to the point y on the source plane

Find the losest ray within the image to the source point y.

ConcaveHullImageArea()

PosType ImageInfo::ConcaveHullImageArea

(

bool

useborder

)

Area of the image using the concave hull of the points on the image plane.

If useborder is true it will use the inner border to save time. When a bourder has not been calculated,as with a critical cureve, it should be set to false.

ConcaveHullSourceArea()

PosType ImageInfo::ConcaveHullSourceArea

(

bool

useborder

)

Area of the image using the concave hull of the points on the image plane.

If useborder is true it will use the inner border to save time. When a bourder has not been calculated,as with a critical cureve, it should be set to false.

constant()

bool ImageInfo::constant	(	LensingVariable	lensvar,
		PosType	tol )

checks if all the points within the image have the same lensvar with the tolarence

Parameters

lensvar	which variable is to be compared
tol	to what tolarence it should be considered equal

copy()

void ImageInfo::copy	(	const ImageInfo &	image,
		bool	copykists = true )

Copy all information about the image including making copies of the imagekist, innerborder and outerborder. Previous information in the image will be.

Parameters

image	image to be copied
copykists	false for turning off copying imagekist, innerborder and outerborder. This is useful when the grid has already been distroyed.

FindArc()

void ImageInfo::FindArc	(	PosType &	radius,
		PosType *	xc,
		PosType *	arc_c,
		PosType &	arclength,
		PosType &	width,
		PosType	resolution,
		PosType	threshold )

Treating the image as an arc, find its parameters, THIS HAS NOT BEEN FINISHED YET!!!

Parameters

threshold

surface brightness threshold as a fcaction of peak surface brightness

Member Data Documentation

imagekist

Kist<Point>* ImageInfo::imagekist

Array of points in image, SHOULD NOT BE USED IN FAVOR OF imagekist! Still used by caustic finding routines.

Number of points in image, SHOULD NOT BE USED IN FAVOR OF imagekist->Nunits(). Still used by caustic finding routines. later addition, holds all points in image, will replace points eventually

---

The documentation for this struct was generated from the following files:

• SLsimLib/include/image_info.h
• SLsimLib/TreeCode_link/Tree.cpp
• SLsimLib/TreeCode_link/TreeDriver.cpp