Method Detail

• countSpatialDimensions

  public static <S extends AnnotatedSpace<A>,A extends TypedAxis> long countSpatialDimensions(S space)

  Counts the number of spatial dimensions in the given space.

  Type Parameters:

  S - type of the space.

  A - type of axes in the space.

  Parameters:

  space - an N-dimensional space.

  Returns:

  number of spatial dimensions in the space.

• getSpatialUnit

  public static <S extends AnnotatedSpace<C>,C extends CalibratedAxis> Optional<String> getSpatialUnit(S space,
                                                                                                       UnitService unitService)
                                                                                                throws IllegalArgumentException

  Returns the common unit of the spatial calibrations of the given space.

  The common unit is the unit of the first spatial axis if it can be converted to the units of the other axes.

  Type Parameters:

  S - type of the space.

  C - type of axis in the space

  Parameters:

  space - an n-dimensional space with calibrated axes.

  unitService - an UnitService to convert axis calibrations.

  Returns:

  an optional with the unit of spatial calibration. It's empty if there's no conversion between the units of spatial axes. The Optional contains an empty string none of the axes have a unit, i.e. they're uncalibrated.

  Throws:

  IllegalArgumentException - if space has no spatial axes.

• hasChannelDimensions

  public static <S extends AnnotatedSpace<A>,A extends TypedAxis> boolean hasChannelDimensions(S space)

  Checks if the given space has a channel dimension.

  Type Parameters:

  S - type of the space.

  A - type of axes in the space.

  Parameters:

  space - an N-dimensional space.

  Returns:

  true if there are any channel type axes.

• hasSpatialDimensions

  public static <S extends AnnotatedSpace<A>,A extends TypedAxis> boolean hasSpatialDimensions(S space)

  Checks if the given space has any spatial dimensions.

  Type Parameters:

  S - type of the space.

  A - type of axes in the space.

  Parameters:

  space - an N-dimensional space.

  Returns:

  true if there are any spatial type axes.

• hasTimeDimensions

  public static <S extends AnnotatedSpace<A>,A extends TypedAxis> boolean hasTimeDimensions(S space)

  Checks if the given space has a time dimension.

  Type Parameters:

  S - type of the space.

  A - type of axes in the space.

  Parameters:

  space - an N-dimensional space.

  Returns:

  true if there are any time type axes.

• isSpatialCalibrationsIsotropic

  public static <S extends AnnotatedSpace<A>,A extends CalibratedAxis> boolean isSpatialCalibrationsIsotropic(S space,
                                                                                                              double tolerance,
                                                                                                              UnitService unitService)
                                                                                                       throws IllegalArgumentException

  Checks if the spatial axes in the space have the same i.e. isotropic scaling.

  If calibrations are isotropic, then the values returned by CalibratedAxis.averageScale(double, double) differ only within the given tolerance. For example, if X-axis scale = 1.00, Y-axis scale = 1.02, and tolerance = 0.03, then calibration is isotropic.

  NB if the calibrations of the axes are not in the same unit, the method tries to convert them to the unit of the first spatial axis (x-axis).

  Type Parameters:

  S - type of the space

  A - type of the axes in the space

  Parameters:

  space - a space with spatial axes

  tolerance - tolerance for anisotropy in scaling

  unitService - service to convert between units of calibration

  Returns:

  true if spatial calibrations are isotropic within tolerance

  Throws:

  IllegalArgumentException - if tolerance is negative or NaN, or calibration units cannot be converted