Strel3D.Shape (MorphoLibJ 1.6.0.1 API)

java.lang.Object
- java.lang.Enum<Strel3D.Shape>
- - inra.ijpb.morphology.Strel3D.Shape

All Implemented Interfaces:

Serializable, Comparable<Strel3D.Shape>

Enclosing interface:

Strel3D
```
public static enum Strel3D.Shape
extends Enum<Strel3D.Shape>
```
An enumeration of the different possible structuring element shapes. Each item of the enumeration can create Strel instances of specific class and of given size.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BALL` Ball of a given radius
`CUBE` Cube of a given side
`DIAMOND` Diamond of a given diameter
`LINE_DIAG_DOWN` Diagonal line of a given length
`LINE_DIAG_UP` Diagonal line of a given length
`LINE_HORIZ` Horizontal line of a given length
`LINE_VERT` Vertical line of a given length
`LINE_Z` 3D line in the Z direction
`OCTAGON` Octagon of a given diameter
`SQUARE` Square of a given side

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Strel3D`	`fromDiameter(int diam)` Creates a structuring element of the given type and with the specified diameter.
`Strel3D`	`fromDiameterList(int diamX, int diamY, int diamZ)` Creates a structuring element of the given type and with the specified diameter.
`static Strel3D.Shape`	`fromLabel(String label)` Determines the strel shape from its label.
`Strel3D`	`fromRadius(int radius)` Creates a structuring element of the given type and with the specified radius.
`Strel3D`	`fromRadiusList(int radiusX, int radiusY, int radiusZ)` Creates a structuring element of the given type and with the specified radius for each dimension.
`static String[]`	`getAllLabels()` Returns a set of labels for most of classical structuring elements.
`String`	`toString()` Returns the label associated to this shape.
`static Strel3D.Shape`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Strel3D.Shape[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - BALL
```
public static final Strel3D.Shape BALL
```
    Ball of a given radius
    
    See Also:
    
    SquareStrel
  - CUBE
```
public static final Strel3D.Shape CUBE
```
    Cube of a given side
    
    See Also:
    
    SquareStrel
  - SQUARE
```
public static final Strel3D.Shape SQUARE
```
    Square of a given side
    
    See Also:
    
    SquareStrel
  - DIAMOND
```
public static final Strel3D.Shape DIAMOND
```
    Diamond of a given diameter
    
    See Also:
    
    DiamondStrel, Cross3x3Strel
  - OCTAGON
```
public static final Strel3D.Shape OCTAGON
```
    Octagon of a given diameter
    
    See Also:
    
    OctagonStrel
  - LINE_HORIZ
```
public static final Strel3D.Shape LINE_HORIZ
```
    Horizontal line of a given length
    
    See Also:
    
    LinearHorizontalStrel
  - LINE_VERT
```
public static final Strel3D.Shape LINE_VERT
```
    Vertical line of a given length
    
    See Also:
    
    LinearVerticalStrel
  - LINE_Z
```
public static final Strel3D.Shape LINE_Z
```
    3D line in the Z direction
    
    See Also:
    
    LinearDepthStrel3D
  - LINE_DIAG_UP
```
public static final Strel3D.Shape LINE_DIAG_UP
```
    Diagonal line of a given length
    
    See Also:
    
    LinearDiagUpStrel
  - LINE_DIAG_DOWN
```
public static final Strel3D.Shape LINE_DIAG_DOWN
```
    Diagonal line of a given length
    
    See Also:
    
    LinearDiagDownStrel
- Method Detail
  - values
```
public static Strel3D.Shape[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Strel3D.Shape c : Strel3D.Shape.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Strel3D.Shape valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - toString
```
public String toString()
```
    Returns the label associated to this shape.
    
    Overrides:
    
    toString in class Enum<Strel3D.Shape>
  - fromRadius
```
public Strel3D fromRadius(int radius)
```
    Creates a structuring element of the given type and with the specified radius. The final size is given by 2 * radius + 1, to take into account the central pixel.
    
    Parameters:
    
    radius - the radius of the structuring element, in pixels
    
    Returns:
    
    a new structuring element
  - fromRadiusList
```
public Strel3D fromRadiusList(int radiusX,
                              int radiusY,
                              int radiusZ)
```
    Creates a structuring element of the given type and with the specified radius for each dimension. The final size is given for each dimension by 2 * radius + 1, to take into account the central pixel.
    
    Parameters:
    
    radiusX - the radius of the structuring element in the x-direction, in pixels
    
    radiusY - the radius of the structuring element in the y-direction, in pixels
    
    radiusZ - the radius of the structuring element in the z-direction, in pixels
    
    Returns:
    
    a new structuring element
  - fromDiameter
```
public Strel3D fromDiameter(int diam)
```
    Creates a structuring element of the given type and with the specified diameter.
    
    Parameters:
    
    diam - the orthogonal diameter of the structuring element (max of x and y sizes), in pixels
    
    Returns:
    
    a new structuring element
  - fromDiameterList
```
public Strel3D fromDiameterList(int diamX,
                                int diamY,
                                int diamZ)
```
    Creates a structuring element of the given type and with the specified diameter.
    
    Parameters:
    
    diamX - the diameter of the structuring element in the X direction
    
    diamY - the diameter of the structuring element in the Y direction
    
    diamZ - the diameter of the structuring element in the Z direction
    
    Returns:
    
    a new structuring element
  - getAllLabels
```
public static String[] getAllLabels()
```
    Returns a set of labels for most of classical structuring elements.
    
    Returns:
    
    a list of labels
  - fromLabel
```
public static Strel3D.Shape fromLabel(String label)
```
    Determines the strel shape from its label.
    
    Parameters:
    
    label - the name of the structuring element
    
    Returns:
    
    a Shape object that can be used to instantiate new structuring elements
    
    Throws:
    
    IllegalArgumentException - if label is not recognized.

Enum Strel3D.Shape

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BALL

CUBE

SQUARE

DIAMOND

OCTAGON

LINE_HORIZ

LINE_VERT

LINE_Z

LINE_DIAG_UP

LINE_DIAG_DOWN

Method Detail

values

valueOf

toString

fromRadius

fromRadiusList

fromDiameter

fromDiameterList

getAllLabels

fromLabel