![]() |
BioImager
3.9.1
A .NET microscopy imaging library. Supports various microscopes by using imported libraries & GUI automation. Supported libraries include PriorĀ® & ZeissĀ® & all devices supported by Micromanager 2.0 and python-microscope.
|
Classes | |
| class | Mask |
| Represents a Mask layer. More... | |
Public Types | |
| enum | Type |
Public Member Functions | |
| ROI | Copy () |
| ROI | Copy (ZCT cord) |
| RectangleD | GetSelectBound (double scaleX, double scaleY) |
| RectangleD[] | GetSelectBoxes () |
| RectangleD[] | GetSelectBoxes (double s) |
| void | UpdatePoint (PointD p, int i) |
| PointD | GetPoint (int i) |
| PointD[] | GetPoints () |
| PointF[] | GetPointsF () |
| void | AddPoint (PointD p) |
| void | AddPoints (PointD[] p) |
| void | AddPoints (float[] xp, float[] yp) |
| void | AddPoints (int[] xp, int[] yp) |
| void | RemovePoints (int[] indexs) |
| int | GetPointCount () |
| PointD[] | stringToPoints (string s) |
| string | PointsToString (BioImage b) |
| void | UpdateBoundingBox () |
| override string | ToString () |
Static Public Member Functions | |
| static ROI | CreatePoint (ZCT coord, double x, double y) |
| static ROI | CreatePoint (int s, int z, int c, int t, double x, double y) |
| static ROI | CreateLine (ZCT coord, PointD x1, PointD x2) |
| static ROI | CreateRectangle (ZCT coord, double x, double y, double w, double h) |
| static ROI | CreateEllipse (ZCT coord, double x, double y, double w, double h) |
| static ROI | CreatePolygon (ZCT coord, PointD[] pts) |
| static ROI | CreateFreeform (ZCT coord, PointD[] pts) |
| static ROI | CreateMask (ZCT coord, float[] mask, int width, int height, PointD loc, double physicalX, double physicalY) |
| static ROI | CreateMask (ZCT coord, byte[] mask, int width, int height, PointD loc, double physicalX, double physicalY) |
Public Attributes | |
| Type | type |
| List< int > | selectedPoints = new List<int>() |
| RectangleD | BoundingBox |
| Font | font = System.Drawing.SystemFonts.DefaultFont |
| ZCT | coord |
| System.Drawing.Color | strokeColor |
| System.Drawing.Color | fillColor |
| bool | isFilled = false |
| string | id = "" |
| string | roiID = "" |
| string | roiName = "" |
| int | serie = 0 |
| string | properties |
| double | strokeWidth = 1 |
| float | fontSize = 8 |
| string | family = "" |
| int | shapeIndex = 0 |
| bool | closed = false |
| bool | selected = false |
Static Public Attributes | |
| static float | selectBoxSize = 8f |
Properties | |
| PointD | Point [get, set] |
| RectangleD | Rect [get, set] |
| double | X [get, set] |
| double | Y [get, set] |
| double | W [get, set] |
| double | H [get, set] |
| List< PointD > | PointsD [get] |
| PointD[] | PointsImage [get] |
| string | Text [get, set] |
| System.Drawing.Size | TextSize [get] |
| Mask | roiMask [get, set] |
| enum BioImager.ROI.Type |
| BioImager.ROI.ROI | ( | ) |
| void BioImager.ROI.AddPoint | ( | PointD | p | ) |
This function adds a point to the list of points that make up the polygon
| PointD |
Definition at line 934 of file Bio.cs.
References BioImager.ROI.UpdateBoundingBox().
Referenced by BioImager.ROI.CreateLine(), BioImager.ROI.CreatePoint(), BioImager.BioImage.OpenOME(), BioImager.BioImage.OpenOMEROIs(), BioImager.Tools.ToolDown(), and BioImager.Tools.ToolUp().
| void BioImager.ROI.AddPoints | ( | float[] | xp, |
| float[] | yp | ||
| ) |
Adds a range of float points to the Points collection and updates the bounding box
| p | The points to add to the polygon |
Definition at line 950 of file Bio.cs.
References BioImager.ROI.UpdateBoundingBox().
| void BioImager.ROI.AddPoints | ( | int[] | xp, |
| int[] | yp | ||
| ) |
Adds a range of float points to the Points collection and updates the bounding box
| p | The points to add to the polygon |
Definition at line 961 of file Bio.cs.
References BioImager.ROI.UpdateBoundingBox().
| void BioImager.ROI.AddPoints | ( | PointD[] | p | ) |
Adds a range of points to the Points collection and updates the bounding box
| p | The points to add to the polygon |
Definition at line 942 of file Bio.cs.
References BioImager.ROI.UpdateBoundingBox().
Referenced by BioImager.ROI.CreateFreeform(), BioImager.ROI.CreatePolygon(), BioImager.BioImage.OpenOME(), BioImager.BioImage.OpenOMEROIs(), and BioImager.BioImage.StringToROI().
| ROI BioImager.ROI.Copy | ( | ) |
Copy() is a function that copies the values of the ROI object to a new ROI object
Definition at line 463 of file Bio.cs.
| ROI BioImager.ROI.Copy | ( | ZCT | cord | ) |
Copy() is a function that copies the ROI object and returns a new ROI object
| ZCT | A class that contains the coordinates of the image. |
Definition at line 491 of file Bio.cs.
|
static |
Create an ellipse ROI at the specified ZCT coordinate with the specified dimensions
| ZCT | The ZCT coordinates of the image you want to create the ROI on. |
| x | x-coordinate of the top-left corner of the rectangle |
| y | The y-coordinate of the upper-left corner of the rectangle to create. |
| w | width |
| h | height |
Definition at line 833 of file Bio.cs.
Referenced by BioImager.ImageJ.RoiDecoder.getRoi().
|
static |
Create a new ROI object of type Freeform, with the specified ZCT coordinates and points
| ZCT | A class that contains the Z, C, and T coordinates of the ROI. |
| pts | an array of PointD objects, which are just a pair of doubles (x,y) |
Definition at line 863 of file Bio.cs.
References BioImager.ROI.AddPoints().
Referenced by BioImager.Tools.ToolUp().
|
static |
Create a line ROI with the specified coordinates
| ZCT | Z is the Z-axis, C is the color channel, and T is the time frame. |
| PointD | A point in the image. |
| PointD | A point in the image. |
Definition at line 796 of file Bio.cs.
References BioImager.ROI.AddPoint().
Referenced by BioImager.ImageJ.RoiDecoder.getRoi().
|
static |
|
static |
|
static |
Create a point ROI at the specified ZCT coordinates and x,y coordinates
| s | series |
| z | the z-slice of the image |
| c | channel |
| t | timepoint |
| x | x coordinate of the point |
| y | y-coordinate of the point |
Definition at line 785 of file Bio.cs.
References BioImager.ROI.CreatePoint().
|
static |
Create a new ROI object, add a point to it, and return it
| ZCT | a class that contains the Z, C, and T coordinates of the image. |
| x | x coordinate of the point |
| y | The y coordinate of the point |
Definition at line 766 of file Bio.cs.
References BioImager.ROI.AddPoint().
Referenced by BioImager.ROI.CreatePoint().
|
static |
Create a new ROI object of type Polygon, with the given coordinate system and points
| ZCT | The ZCT coordinate of the ROI. |
| pts | an array of PointD objects, which are just a pair of doubles (x,y) |
Definition at line 848 of file Bio.cs.
References BioImager.ROI.AddPoints().
|
static |
Create a new ROI object with a rectangle shape, and add a line to the recorder
| ZCT | The ZCT coordinates of the image you want to create the ROI on. |
| x | x coordinate of the top left corner of the rectangle |
| y | y-coordinate of the top-left corner of the rectangle |
| w | width |
| h | height |
Definition at line 815 of file Bio.cs.
Referenced by BioImager.ImageJ.RoiDecoder.getRoi().
| PointD BioImager.ROI.GetPoint | ( | int | i | ) |
This function returns the point at the specified index
| i | The index of the point to get. |
Definition at line 907 of file Bio.cs.
Referenced by BioImager.ImageView.RenderFrame(), and BioImager.BioImage.SaveOMESeries().
| int BioImager.ROI.GetPointCount | ( | ) |
This function returns the number of points in the polygon
Definition at line 992 of file Bio.cs.
Referenced by BioImager.ImageView.RenderFrame(), BioImager.Tools.ToolDown(), and BioImager.Tools.ToolUp().
| PointD[] BioImager.ROI.GetPoints | ( | ) |
It returns an array of PointD objects
Definition at line 914 of file Bio.cs.
Referenced by BioImager.BioImage.ROIToString().
| PointF[] BioImager.ROI.GetPointsF | ( | ) |
It converts a list of points to an array of points
Definition at line 921 of file Bio.cs.
| RectangleD BioImager.ROI.GetSelectBound | ( | double | scaleX, |
| double | scaleY | ||
| ) |
This function returns a rectangle that is the bounding box of the object, but with a
border of half the scale
| scale | the scale of the image |
Definition at line 724 of file Bio.cs.
Referenced by BioImager.Tools.ToolUp().
| RectangleD[] BioImager.ROI.GetSelectBoxes | ( | ) |
It creates a list of rectangles, each rectangle is a square with a side length of ROI.selectBoxSize, and the center of the square is the point in the list of points
Definition at line 734 of file Bio.cs.
Referenced by BioImager.ImageView.RenderFrame(), and BioImager.Tools.ToolUp().
| RectangleD[] BioImager.ROI.GetSelectBoxes | ( | double | s | ) |
It returns an array of RectangleF objects that are used to draw the selection boxes around the points of the polygon
| s | the size of the select box |
Definition at line 749 of file Bio.cs.
| string BioImager.ROI.PointsToString | ( | BioImage | b | ) |
This function takes a BioImage object and returns a string of the points in the image space
Definition at line 1023 of file Bio.cs.
References BioImager.BioImage.ToImageSpace().
Referenced by BioImager.BioImage.SaveOMESeries().
| void BioImager.ROI.RemovePoints | ( | int[] | indexs | ) |
It removes points from a list of points based on an array of indexes
| indexs | an array of integers that represent the indexes of the points to be removed |
Definition at line 972 of file Bio.cs.
References BioImager.ROI.UpdateBoundingBox().
Referenced by BioImager.Tools.ToolDown().
| PointD[] BioImager.ROI.stringToPoints | ( | string | s | ) |
It takes a string of points and returns an array of PointD objects
| s | The string to convert to points. |
Definition at line 1001 of file Bio.cs.
Referenced by BioImager.BioImage.OpenOME(), BioImager.BioImage.OpenOMEROIs(), and BioImager.BioImage.StringToROI().
| override string BioImager.ROI.ToString | ( | ) |
It returns a string that contains the type of the object, the text, the width and height, and the coordinates of the object
Definition at line 1081 of file Bio.cs.
| void BioImager.ROI.UpdateBoundingBox | ( | ) |
It takes the minimum and maximum X and Y values of the points in the shape and uses them to create a bounding box
Definition at line 1038 of file Bio.cs.
Referenced by BioImager.ROI.AddPoint(), BioImager.ROI.AddPoints(), BioImager.ROI.RemovePoints(), and BioImager.ROI.UpdatePoint().
| void BioImager.ROI.UpdatePoint | ( | PointD | p, |
| int | i | ||
| ) |
This function updates the point at the specified index
| PointD | A class that contains an X and Y coordinate. |
| i | The index of the point to update |
Definition at line 894 of file Bio.cs.
References BioImager.ROI.UpdateBoundingBox().
Referenced by BioImager.Tools.ToolUp().
| Font BioImager.ROI.font = System.Drawing.SystemFonts.DefaultFont |
| Type BioImager.ROI.type |
Definition at line 423 of file Bio.cs.
Referenced by microscope.stages.linkam._CommsInfo.view_of_info().
|
getset |
|
getset |
Definition at line 307 of file Bio.cs.
|
get |
|
get |
|
getset |
Definition at line 329 of file Bio.cs.
|
getset |
Definition at line 515 of file Bio.cs.
|
get |
|
getset |
|
getset |
|
getset |