Module gwy :: Class GrainQuantity

Class GrainQuantity

Grain quantity to request from DataField.grains_get_distribution() and similar functions.

Note: All the enumerated values are defined at the module level, not the class level. The are just groupped by class here for easier orientation.

Class Variables

[hide private]

GRAIN_VALUE_BOUNDARY_MAXIMUM
Maximum value in the grain inner boundary.

GRAIN_VALUE_BOUNDARY_MINIMUM
Minimum value on the grain inner boundary.

GRAIN_VALUE_CENTER_X
Grain centre horizontal position, i.e.

GRAIN_VALUE_CENTER_Y
Grain centre vertical position, i.e.

GRAIN_VALUE_CIRCUMCIRCLE_R
Radius of minimum circle containing the grain.

GRAIN_VALUE_CIRCUMCIRCLE_X
Real X-coordinate of the centre of the minimum circumcircle.

GRAIN_VALUE_CIRCUMCIRCLE_Y
Real Y-coordinate of the centre of the minimum circumcircle.

GRAIN_VALUE_CONVEX_HULL_AREA
Projected (flat) area of grain convex hull.

GRAIN_VALUE_CURVATURE1
Smaller grain curvature.

GRAIN_VALUE_CURVATURE2
Larger grain curvature.

GRAIN_VALUE_CURVATURE_ANGLE1
Direction of the smaller grain curvature radius.

GRAIN_VALUE_CURVATURE_ANGLE2
Direction of the larger grain curvature radius.

GRAIN_VALUE_CURVATURE_CENTER_X
Grain curvature centre horizontal position.

GRAIN_VALUE_CURVATURE_CENTER_Y
Grain curvature centre vertical position.

GRAIN_VALUE_CURVATURE_CENTER_Z
The value at curvature centre.

GRAIN_VALUE_EQUIV_DISC_RADIUS
Radius of a disc with the same area as the grain.

GRAIN_VALUE_EQUIV_ELLIPSE_ANGLE
Orientation of the major axis of equivalent ellipse.

GRAIN_VALUE_EQUIV_ELLIPSE_MAJOR
Length of major semiaxis of equivalent ellipse.

GRAIN_VALUE_EQUIV_ELLIPSE_MINOR
Length of minor semiaxis of equivalent ellipse.

GRAIN_VALUE_EQUIV_SQUARE_SIDE
Side of a square with the same area as the grain.

GRAIN_VALUE_FLAT_BOUNDARY_LENGTH
Length of projected grain boundary.

GRAIN_VALUE_HALF_HEIGHT_AREA
Projected area of the part of grain that is above the half-height, i.e.

GRAIN_VALUE_INSCRIBED_DISC_R
Radius of maximum disc that fits inside the grain (Since 2.30)

GRAIN_VALUE_INSCRIBED_DISC_X
Real X-coordinate of the centre of the maximum inscribed disc.

GRAIN_VALUE_INSCRIBED_DISC_Y
Real Y-coordinate of the centre of the maximum inscribed disc.

GRAIN_VALUE_MAXIMUM
Minimum value.

GRAIN_VALUE_MAXIMUM_BOUND_ANGLE
Direction of the maximum lateral bounding size (arbitrary one if the maximum is not unique).

GRAIN_VALUE_MAXIMUM_BOUND_SIZE
Maximum lateral bounding size, in other words the maximum length of grain projection to any line in the horizontal plane.

GRAIN_VALUE_MAXIMUM_MARTIN_ANGLE
Direction corresponding to maximum Martin diameter.

GRAIN_VALUE_MAXIMUM_MARTIN_DIAMETER
Maximum value of Martin diameter.

GRAIN_VALUE_MEAN
Mean value.

GRAIN_VALUE_MEAN_RADIUS
Mean distance from boundary to the grain centre as defined by GRAIN_VALUE_CENTER_X and GRAIN_VALUE_CENTER_Y.

GRAIN_VALUE_MEDIAN
Median value.

GRAIN_VALUE_MINIMUM
Maximum value.

GRAIN_VALUE_MINIMUM_BOUND_ANGLE
Direction of the minimum lateral bounding size (arbitrary one if the minimum is not unique).

GRAIN_VALUE_MINIMUM_BOUND_SIZE
Minimum lateral bounding size, in other words the minimum length of grain projection to any line in the horizontal plane.

GRAIN_VALUE_MINIMUM_MARTIN_ANGLE
Direction corresponding to minimum Martin diameter.

GRAIN_VALUE_MINIMUM_MARTIN_DIAMETER
Minimum value of Martin diameter.

GRAIN_VALUE_PIXEL_AREA
Flat grain area measured in pixels.

GRAIN_VALUE_PROJECTED_AREA
Projected (flat) grain area.

GRAIN_VALUE_RMS
Standard deviation of grain values.

GRAIN_VALUE_SLOPE_PHI
Spherical angle phi of grain normal (0 is in positive x direction).

GRAIN_VALUE_SLOPE_THETA
Spherical angle theta of grain normal (0 is upwards).

GRAIN_VALUE_SURFACE_AREA
Surface area.

GRAIN_VALUE_VOLUME_0
Grain volume calculated with grain basis at z=0 (therefore it is just an integral it can be negative).

GRAIN_VALUE_VOLUME_LAPLACE
Grain volume calculated with grain basis calculated by laplacian interpolation of surrounding values.

GRAIN_VALUE_VOLUME_MIN
Grain volume calculated with grain basis at grain minimum value.

Class Variable Details

[hide private]

GRAIN_VALUE_BOUNDARY_MAXIMUM

Maximum value in the grain inner boundary. (Since 2.12)

GRAIN_VALUE_BOUNDARY_MINIMUM

Minimum value on the grain inner boundary. (Since 2.12)

GRAIN_VALUE_CENTER_X

Grain centre horizontal position, i.e. the mean value of its physical x-coordinates. (Since 2.7)

GRAIN_VALUE_CENTER_Y

Grain centre vertical position, i.e. the mean value of its physical y-coordinates. (Since 2.7)

GRAIN_VALUE_CIRCUMCIRCLE_R

Radius of minimum circle containing the grain. (Since 2.30)

GRAIN_VALUE_CIRCUMCIRCLE_X

Real X-coordinate of the centre of the minimum circumcircle. (Since 2.30)

GRAIN_VALUE_CIRCUMCIRCLE_Y

Real Y-coordinate of the centre of the minimum circumcircle. (Since 2.30)

GRAIN_VALUE_CONVEX_HULL_AREA

Projected (flat) area of grain convex hull. (Since 2.30)

GRAIN_VALUE_CURVATURE1

Smaller grain curvature. (Since 2.22)

GRAIN_VALUE_CURVATURE2

Larger grain curvature. (Since 2.22)

GRAIN_VALUE_CURVATURE_ANGLE1

Direction of the smaller grain curvature radius. If the grain is flat or too small the angle is reported as 0. (Since 2.22)

GRAIN_VALUE_CURVATURE_ANGLE2

Direction of the larger grain curvature radius. If the grain is flat or too small the angle is reported as π/2. (Since 2.22)

GRAIN_VALUE_CURVATURE_CENTER_X

Grain curvature centre horizontal position. For too small or flat grains it reduces to the horizontal position of geometrical centre. (Since 2.22)

GRAIN_VALUE_CURVATURE_CENTER_Y

Grain curvature centre vertical position. For too small or flat grains it reduces to the vertical position of geometrical centre. (Since 2.22)

GRAIN_VALUE_CURVATURE_CENTER_Z

The value at curvature centre. Note this is the value in the origin of the fitted quadratic surface, not at the real surface. (Since 2.22)

GRAIN_VALUE_EQUIV_ELLIPSE_ANGLE

Orientation of the major axis of equivalent ellipse. (Since 2.36)

GRAIN_VALUE_EQUIV_ELLIPSE_MAJOR

Length of major semiaxis of equivalent ellipse. (Since 2.36)

GRAIN_VALUE_EQUIV_ELLIPSE_MINOR

Length of minor semiaxis of equivalent ellipse. (Since 2.36)

GRAIN_VALUE_FLAT_BOUNDARY_LENGTH

Length of projected grain boundary. Note for grains not topologically equivalent to disc, only the length of the outer boundary is calculated.

GRAIN_VALUE_HALF_HEIGHT_AREA

Projected area of the part of grain that is above the half-height, i.e. the height between the minimum and maximum (Since 2.8).

GRAIN_VALUE_INSCRIBED_DISC_X

Real X-coordinate of the centre of the maximum inscribed disc. (Since 2.30)

GRAIN_VALUE_INSCRIBED_DISC_Y

Real Y-coordinate of the centre of the maximum inscribed disc. (Since 2.30)

GRAIN_VALUE_MAXIMUM_MARTIN_ANGLE

Direction corresponding to maximum Martin diameter. (Since 2.50)

GRAIN_VALUE_MAXIMUM_MARTIN_DIAMETER

Maximum value of Martin diameter. (Since 2.50)

GRAIN_VALUE_MEAN_RADIUS

Mean distance from boundary to the grain centre as defined by GRAIN_VALUE_CENTER_X and GRAIN_VALUE_CENTER_Y. (Since 2.30)

GRAIN_VALUE_MINIMUM_MARTIN_ANGLE

Direction corresponding to minimum Martin diameter. (Since 2.50)

GRAIN_VALUE_MINIMUM_MARTIN_DIAMETER

Minimum value of Martin diameter. (Since 2.50)

GRAIN_VALUE_PIXEL_AREA

Flat grain area measured in pixels. This value is redundant but it is useful for filtering (Since 2.37).

GRAIN_VALUE_RMS

Standard deviation of grain values. (Since 2.51)

GRAIN_VALUE_SLOPE_PHI

Spherical angle phi of grain normal (0 is in positive x direction). (Since 2.7)

GRAIN_VALUE_SLOPE_THETA

Spherical angle theta of grain normal (0 is upwards). (Since 2.7)

GRAIN_VALUE_VOLUME_0

Grain volume calculated with grain basis at z=0 (therefore it is just an integral it can be negative). (Since 2.3)

GRAIN_VALUE_VOLUME_LAPLACE

Grain volume calculated with grain basis calculated by laplacian interpolation of surrounding values. (Since 2.3)

GRAIN_VALUE_VOLUME_MIN

Grain volume calculated with grain basis at grain minimum value. This value is a lower bound. (Since 2.3)