define ['angular', 'underscore.string', 'image', 'nifti'], (ng, _s) ->
  timeSeries = ng.module 'qiprofile.timeseries', ['qiprofile.image', 'qiprofile.nifti'] 

  timeSeries.factory 'TimeSeries', ['Image', 'Nifti', (Image, Nifti) ->
    # Adds the following properties to the given REST Image object:
    # * the Image.extend properties
    # * *timeSeries* - the parent time series
    # * *resource* - the parent time series name
    extendImage = (image, timeSeries) ->
      # Extend the image with load capability.
      Image.extend(timeSeries.image)
      # Add the parent reference.
      image.timeSeries = timeSeries
      # Add the virtual properties.
      Object.defineProperties image,
        # @returns the parent time series name
        resource:
          get: -> @timeSeries.name     
        
        # @returns the parent time series parent image sequence
        imageSequence:
          get: -> @timeSeries.imageSequence
        
        # @returns the [x, y, z, v] sizes
        shape:
          get: ->
            if not @timeSeries.image.isLoaded()
              throw new Error("The #{ @timeSeries.title } is not loaded")
            @timeSeries.image.contents.data.shape
        
        # @returns the {size: number of volumes} object
        volumes:
          get: ->
            size: @timeSeries.imageSequence.volumes.images.length
        
        # @returns the {size: number of slices} object
        slices:
          get: ->
            size: @shape[0]

    # Adds the following properties to the given REST TimeSeries
    # object:
    # * *imageSequence* - the abstract parent image sequence
    #   reference
    # * the concrete parent *scan* or *registration* reference
    #
    # The time series *image* is also extended as described in
    # extendImage.
    #
    # @param timeSeries the REST TimeSeries object to extend
    # @param imageSequence the parent ImageSequence object
    # @return the extended TimeSeries
    extend: (timeSeries, imageSequence) ->
      # The generic parent reference property.
      timeSeries.imageSequence = imageSequence

      # The concrete parent reference (scan or registration).
      propertyName = _s.decapitalize(imageSequence._cls)
      Object.defineProperty timeSeries, propertyName,
        get: -> @imageSequence

      # Make the title virtual property.
      Object.defineProperties timeSeries,
        # @returns the display title
        title:
          get: ->
            "#{ @imageSequence.title } Time Series"

      # Extend the image.
      extendImage(timeSeries.image, timeSeries)
      # If there is an overlay, then extend it as while.
      if timeSeries.overlay?
        extendImage(timeSeries.overlay, timeSeries)
      
      # Return the extnded time series.
      timeSeries
  ]