class_docstr: Aligner interface for dtw-python.
  
  Behaviour: computes the full alignment between X[0] and X[1]
      assumes pairwise alignment (only two series) and univariate
      if multivariate series are passed:
      alignment is computed on univariate series with variable_to_align;
      if this is not set, defaults to the first variable of X[0]
      raises an error if variable_to_align is not present in X[0] or X[1]
  
  Parameters
  ----------
  dist_method : str, optional, default = "euclidean"
      distance function to use, a distance on real n-space
      one of the functions in `scipy.spatial.distance.cdist`
  step_pattern : str, optional, or dtw_python stepPattern object, optional
      step pattern to use in time warping
      one of: 'symmetric1', 'symmetric2' (default), 'asymmetric',
      and dozens of other more non-standard step patterns;
      list can be displayed by calling help(stepPattern) in dtw
  window_type : string, the chosen windowing function
      "none", "itakura", "sakoechiba", or "slantedband"
      "none" (default) - no windowing
      "sakoechiba" - a band around main diagonal
      "slantedband" - a band around slanted diagonal
      "itakura" - Itakura parallelogram
  open_begin : boolean, optional, default=False
  open_end: boolean, optional, default=False
      whether to perform open-ended alignments
      open_begin = whether alignment open ended at start (low index)
      open_end = whether alignment open ended at end (high index)
  variable_to_align : string, default = first variable in X[0] as passed to fit
      which variable to use for univariate alignment
class_docstr_tok: ["Aligner","interface","for","dtw-python",".","Behaviour",":","computes","the","full","alignment","between","X","[","0","]","and","X","[","1","]","assumes","pairwise","alignment","(","only","two","series",")","and","univariate","if","multivariate","series","are","passed",":","alignment","is","computed","on","univariate","series","with","variable_to_align",";","if","this","is","not","set",",","defaults","to","the","first","variable","of","X","[","0","]","raises","an","error","if","variable_to_align","is","not","present","in","X","[","0","]","or","X","[","1","]","Parameters","--","--","--","--","--","dist_method",":","str",",","optional",",","default","=","``","euclidean","''","distance","function","to","use",",","a","distance","on","real","n-space","one","of","the","functions","in","`","scipy.spatial.distance.cdist","`","step_pattern",":","str",",","optional",",","or","dtw_python","stepPattern","object",",","optional","step","pattern","to","use","in","time","warping","one","of",":","'symmetric1","'",",","'symmetric2","'","(","default",")",",","'asymmetric","'",",","and","dozens","of","other","more","non-standard","step","patterns",";","list","can","be","displayed","by","calling","help","(","stepPattern",")","in","dtw","window_type",":","string",",","the","chosen","windowing","function","``","none","''",",","``","itakura","''",",","``","sakoechiba","''",",","or","``","slantedband","''","``","none","''","(","default",")","-","no","windowing","``","sakoechiba","''","-","a","band","around","main","diagonal","``","slantedband","''","-","a","band","around","slanted","diagonal","``","itakura","''","-","Itakura","parallelogram","open_begin",":","boolean",",","optional",",","default=False","open_end",":","boolean",",","optional",",","default=False","whether","to","perform","open-ended","alignments","open_begin","=","whether","alignment","open","ended","at","start","(","low","index",")","open_end","=","whether","alignment","open","ended","at","end","(","high","index",")","variable_to_align",":","string",",","default","=","first","variable","in","X","[","0","]","as","passed","to","fit","which","variable","to","use","for","univariate","alignment"]
docstr: Return overall distance of alignment.
  
  Behaviour: returns overall distance corresponding to alignment
      not all aligners will return or implement this (optional)
  
  Returns
  -------
  distance: float - overall distance between all elements of X passed to fit
docstr_tok: ["Return","overall","distance","of","alignment",".","Behaviour",":","returns","overall","distance","corresponding","to","alignment","not","all","aligners","will","return","or","implement","this","(","optional",")","Returns","--","--","--","-","distance",":","float","-","overall","distance","between","all","elements","of","X","passed","to","fit"]
code: def _get_distance(self):
      """Return overall distance of alignment.
  
      Behaviour: returns overall distance corresponding to alignment
          not all aligners will return or implement this (optional)
  
      Returns
      -------
      distance: float - overall distance between all elements of X passed to fit
      """
      return self.alignment_.distance
  
file_path: sktime/sktime/alignment/dtw_python.py
imports: import numpy
  import pandas
  from sktime.alignment.base import BaseAligner
label_desc: Use image node_id 4 for calling the AlignerDTW obj's underlying member method code with example usage: obj._get_distance() and returns: self