Module: RTKIT::ImageParent

Included in:
DoseVolume, ImageSeries
Defined in:
lib/rtkit/mixins/image_parent.rb

Overview

This is a mixin-module for the classes that are image ‘parents’, i.e. they contain a reference to an array of image instances.

This module is mixed in by the ImageSeries and Volume classes.

Instance Method Summary collapse

Instance Method Details

#slice_spacing ⇒ Object

Returns the slice spacing (a float value in units of mm), which describes the distance between two neighbouring images in this image series. NB! If the image series contains 0 or 1 image, a slice spacing can not be determined and nil is returned.



15
16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/rtkit/mixins/image_parent.rb', line 15

def slice_spacing
  if @slice_spacing
    # If the slice spacing has already been computed, return it instead of recomputing:
    return @slice_spacing
  else
    if @images.length > 1
      # Collect slice positions:
      slice_positions = NArray.to_na(@images.collect{|image| image.pos_slice})
      spacings = (slice_positions[1..-1] - slice_positions[0..-2]).abs
      @slice_spacing = spacings.to_a.most_common_value
    end
  end
end

#update_image_position(image, new_pos) ⇒ Object

Updates the position that is registered for the image for this series.

Raises:

  • (ArgumentError) 


31
32
33
34
35
36
37
 
# File 'lib/rtkit/mixins/image_parent.rb', line 31

def update_image_position(image, new_pos)
  raise ArgumentError, "Invalid argument 'image'. Expected Image, got #{image.class}." unless image.is_a?(Image)
  # Remove old position key:
  @image_positions.delete(image.pos_slice)
  # Add the new position:
  @image_positions[new_pos] = image
end