Package org.anchoranalysis.annotation.io.assignment

Class ObjectVoxelIntersection

Object
org.anchoranalysis.annotation.io.assignment.ObjectVoxelIntersection
All Implemented Interfaces:
Assignment<org.anchoranalysis.image.voxel.object.ObjectMask>
public class ObjectVoxelIntersection
extends Object
implements Assignment<org.anchoranalysis.image.voxel.object.ObjectMask>
Creates an assignment between intersecting voxels in two objects.

Voxels are considered to be assigned, if the exact same voxel exists in both ObjectMasks, and otherwise a voxel is considered unassigned.

Calculates statistics based upon corresponding two object-masks:

The object-masks are arbitrarily termed left and right.

Author:
Owen Feehan

  • Constructor Summary

    Constructors 
    Constructor Description
    ObjectVoxelIntersection​(org.anchoranalysis.image.voxel.object.ObjectMask left, org.anchoranalysis.image.voxel.object.ObjectMask right)
    Determines a voxel-assignment between two objects.

  • Method Summary

    Modifier and Type Method Description
    int numberPaired()
    The number of items that are paired.
    int numberUnassigned​(boolean left)
    The number of items in a particular set that are not paired.
    List<org.anchoranalysis.image.voxel.object.ObjectMask> paired​(boolean left)
    The items that are paired for a particular set.
    StatisticsToExport statistics()
    The statistics associated with the assignment.
    List<org.anchoranalysis.image.voxel.object.ObjectMask> unassigned​(boolean left)
    The items that are not paired for a particular set.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ObjectVoxelIntersection

      public ObjectVoxelIntersection​(org.anchoranalysis.image.voxel.object.ObjectMask left, org.anchoranalysis.image.voxel.object.ObjectMask right)
      Determines a voxel-assignment between two objects.
      Parameters:
      left - the left-object.
      right - the right-object.

  • Method Details

    • numberPaired

      public int numberPaired()
      Description copied from interface: Assignment
      The number of items that are paired.

      This is necessarily the same number for either set.

      Specified by:
      numberPaired in interface Assignment<org.anchoranalysis.image.voxel.object.ObjectMask>
      Returns:
      the total number of pairings.

    • numberUnassigned

      public int numberUnassigned​(boolean left)
      Description copied from interface: Assignment
      The number of items in a particular set that are not paired.
      Specified by:
      numberUnassigned in interface Assignment<org.anchoranalysis.image.voxel.object.ObjectMask>
      Parameters:
      left - if true, the left-set is considered, otherwise the right-set.
      Returns:
      the number of unpaired items for the respective set.

    • paired

      public List<org.anchoranalysis.image.voxel.object.ObjectMask> paired​(boolean left)
      Description copied from interface: Assignment
      The items that are paired for a particular set.
      Specified by:
      paired in interface Assignment<org.anchoranalysis.image.voxel.object.ObjectMask>
      Parameters:
      left - if true, the left-set is considered, otherwise the right-set.
      Returns:
      a newly created list containing the paired items.

    • unassigned

      public List<org.anchoranalysis.image.voxel.object.ObjectMask> unassigned​(boolean left)
      Description copied from interface: Assignment
      The items that are not paired for a particular set.
      Specified by:
      unassigned in interface Assignment<org.anchoranalysis.image.voxel.object.ObjectMask>
      Parameters:
      left - if true, the left-set is considered, otherwise the right-set.
      Returns:
      a newly created list containing the unpaired items for the respective set.

    • statistics

      public StatisticsToExport statistics()
      Description copied from interface: Assignment
      The statistics associated with the assignment.
      Specified by:
      statistics in interface Assignment<org.anchoranalysis.image.voxel.object.ObjectMask>
      Returns:
      the statistics.