Series(file_name=None)  

The Series class stores time-varying Path objects.                        

The Series class can be used to read in an SV project .pth XML file and    
extract path data derived from time-varying imaging data. The path data for 
a given timestep element is identified using a discrete integer time step. 

Example: Read in an SV project .pth file.                                  

   path_series = sv.pathplanning.Series('aorta.pth')                       


Args: 
  file_name (Optional[str]): The name of an SV .pth file. 

get_calculation_number() 
   
   Get the path group's calculation number. 
   
   Returns (int): The path group's calculation number. 

get_method() 
   
   Get the path group method. 
   
   Returns (str): The path group's method name. 

get_num_times() 
   
   Get the number of time steps paths are defined for.  
   
   Returns (int): The number of time steps paths are defined for. 

get_path(time=0) 
   
   Get the path for a given time. 
   
   Args: 
     time (Optional[int]): The time to get the path for. 
   
   Returns (sv.path.Path object): The path object for the given time.

get_path_id() 
   
   Get the path time ID. 
   
   Returns (int): The time ID of the path series. 

get_spacing() 
   
   Get the spacing for the path group. 
   
   Returns (float): The spacing for the path group. 

set_calculation_number(number) 
   
   Set the path group's calculation number. 
   
   Args: 
     number (int): The calculation number. 

set_method(method) 
   
   Set the path group method. 
   
   Args: 
     method (str): The subdivision method name. Valid names are: SPACING, SUBDIVISION or TOTAL 

set_path(path, time) 
   
   Set the path for a given time. 
   
   Args: 
     path (sv.path.Path object): The path object to set.
     time (int): The time to set the path for. 

set_path_id(id) 
   
   Set the ID for the path group. 
   
   Args: 
     id (int): The path ID.

set_spacing(spacing) 
   
   Set the spacing used by the SPACING method. 
   
   Args: 
     spacing (float): The spacing value. 

write(file_name) 
   
   Write the path group to an SV .pth file.
   
   Args: 
     file_name (str): The name of the file to write the path group to.