Profile

_ProfileLineSettings, _ProfileProperties, _ProfilePropertiesBasic, _ZProfile_Options, _ZProfileLineSettings, _ZProfileProperties, BestFitGetCircle, InsertProfileLine, InsertZProfileLine, MeasureProfile, ProfileFullSize, ProfileMeasureComponent, ProfileProperties, ProfileReverse, PSF_MeasureFWHM, RemoveProfileLine, RemoveZProfileLine, ShowProfile, ToggleProfile

BestFitGetCircle

Description 

 BestFitGetCircle(
   double *LpGetCircleCenterX,
   double *LpGetCircleCenterY,
   double *LpGetCircleRadius,
   double *LpGetCircleXYCoorsX,
   double *LpGetCircleXYCoorsY,
   int  GetCircleXYCount
);

Takes an array of XY points, fits a circle in it optimally and returns the circle position and radius.

Parameters

double *LpGetCircleCenterX

X coordinate of the circle center.

double *LpGetCircleCenterY

Y coordinate of the circle center.

double *LpGetCircleRadius

Circle radius

double *LpGetCircleXYCoorsX

Array of X coordinates of the XY point set.

double *LpGetCircleXYCoorsY

Array of Y coordinates of the XY point set.

int GetCircleXYCount

Number of XY points.

InsertProfileLine

This function runs the Add Profile Line command.

Description 

 InsertProfileLine();

Inserts a new profile line.

InsertZProfileLine

Description 

 InsertZProfileLine();

Inserts a new Z-Profile line.

MeasureProfile

This function runs the Measure > Intensity Profile command.

Description 

 MeasureProfile();

This function can be used for interactive profile measurements. The function displays profile cursor and allows you to draw a line.

ProfileFullSize

Description 

 ProfileFullSize();

Stretches the intensity profile line to full-width/height of the image. It works only with the horizontal/vertical type of the profile.

ProfileMeasureComponent

Description 

 ProfileMeasureComponent(
   int  Component
);

Sets the data source for the intensity profile graph on an RGB image. This way you can observe any channel, bud display intensity profile of another.

Parameters

int Component

Defines the component of the current RGB image to be measured.

-2

Measure on Intensity.

-1

The currently selected channel.

0

Red.

1

Green.

2

Blue.

ProfileProperties

Interactive command to this function: View > Layers Properties > Profile Properties

Description 

 ProfileProperties(
   int  ProfileColor,
   double  ProfileLineWidth,
   int  ProfileNeighbourhood
);

This function adjusts calculation of the profile and appearance of the intensity profile line.

Parameters

int ProfileColor

The color as a 32-bit signed integer (hexadecimal form:0xffRRGGBB).

double ProfileLineWidth

The profile line width in pixels

int ProfileNeighbourhood

The profile line neighbourhood in pixels. The value is used in profile data calculation.

ProfileReverse

Description 

 ProfileReverse();

Reverses the direction (arrow placement) of the intensity profile, so the X axis of the graph gets reversed as well. It works only with the horizontal or vertical type of the profile.

PSF_MeasureFWHM

Description 

 PSF_MeasureFWHM(
   double *LpFWHM_X,
   double *LpFWHM_Y,
   double *LpFWHM_Z
);

Compute Full Width at Half Maximum (FWHM) dimensions of a Point-Spread Function (PSF). It operates on the currently active opened document and returns the X, Y, Z FWHM values in its parameters (per channel).

Parameters

double *LpFWHM_X

X FWHM value.

double *LpFWHM_Y

Y FWHM value.

double *LpFWHM_Z

Z FWHM value.

RemoveProfileLine

Description 

 RemoveProfileLine();

Removes the profile line.

RemoveZProfileLine

Description 

 RemoveZProfileLine();

Removes the Z-Profile line.

ShowProfile

Description 

 ShowProfile(
   int  ShowProfile
);

This function displays/hides the intensity profile in the current image.

Parameters

int ShowProfile

0

Hide

1

Show

ToggleProfile

Description 

 ToggleProfile();

This function displays/hides the intensity profile arrow inside the image and also displays/hides the intensity profile docking window.

_ProfileLineSettings

Description 

 _ProfileLineSettings();

Opens the Profile Line Properties dialog window used for adjusting the color, width and style of the intensity profile line.

_ProfileProperties

This function runs the View > Layers Properties > Profile Properties command.

Description 

 _ProfileProperties();

This function displays the Intensity Profile Properties dialog window.

_ProfilePropertiesBasic

Description 

 _ProfilePropertiesBasic();

This function displays the basic Intensity Profile Properties dialog window.

_ZProfileLineSettings

Description 

 _ZProfileLineSettings();

Opens the Profile Line Properties dialog window used for adjusting the color, width and style of the Z profile line.

_ZProfileProperties

Description 

 _ZProfileProperties();

This command displays the Z Profile dialog window, where the Line Color, Line Width, and Neighbourhood of the Z profile can be set. The EDF focused image must be created in order for this function to work.

_ZProfile_Options

Description 

 _ZProfile_Options();

This function opens the Z-Profile Options dialog window which modifies the appearance of the Z-profile graph and other settings.