Package org.anchoranalysis.image.voxel.kernel

Class KernelApplicationParameters

Object
KernelApplicationParameters
public final class KernelApplicationParameters extends Object
Parameters used for applying a Kernel to a BinaryVoxels.
Author:
Owen Feehan

  • Constructor Details

    • KernelApplicationParameters

      public KernelApplicationParameters(OutsideKernelPolicy outsideKernelPolicy, boolean useZ)
      Creates a new KernelApplicationParameters instance.
      Parameters:
      outsideKernelPolicy - How to handle voxels that appear in a neighborhood that lies outside the scene boundaries.
      useZ - Whether to additionally apply the kernel along the Z dimension, as well as X and Y?

  • Method Details

    • isIgnoreOutside

      public boolean isIgnoreOutside()
      When true, any parts of the neighborhood that lie outside the scene are not considered in kernel neighborhoods.
      Returns:
      true if parts of the neighborhood that lie outside the scene should be ignored.

    • isOutsideOn

      public boolean isOutsideOn()
      In cases where isIgnoreOutside() is false, then whether to treat voxels that lie outside the scene as on (if true) or off (if false).
      Returns:
      true if voxels lying outside the scene should be treated as on in the above circumstances, otherwise they are treated as off.

    • isOutsideOffUnignored

      public boolean isOutsideOffUnignored()
      True only when voxels outside the scene should not be ignored and considered as off.
      Returns:
      true iff both conditions above are true.

    • isOutsideOnUnignored

      public boolean isOutsideOnUnignored()
      True only when voxels outside the scene should not be ignored and considered as on.
      Returns:
      true iff both conditions above are true.

    • getOutsideKernelPolicy

      public OutsideKernelPolicy getOutsideKernelPolicy()
      How to handle voxels that appear in a neighborhood that lies outside the scene boundaries.

    • isUseZ

      public boolean isUseZ()
      Whether to additionally apply the kernel along the Z dimension, as well as X and Y?

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object