class_docstr: An internal class to manage filters/algorithms for polydata datasets.
class_docstr_tok: ["An","internal","class","to","manage","filters\/algorithms","for","polydata","datasets","."]
docstr: Compute the arc length over the length of the probed line.
  
  It adds a new point-data array named ``"arc_length"`` with the
  computed arc length for each of the polylines in the
  input. For all other cell types, the arc length is set to 0.
  
  Parameters
  ----------
  progress_bar : bool, default: False
      Display a progress bar to indicate progress.
  
  Returns
  -------
  float
      Arc length of the length of the probed line.
  
  Examples
  --------
  >>> import pyvista as pv
  >>> sphere = pv.Sphere()
  >>> path = sphere.geodesic(0, 100)
  >>> length = path.compute_arc_length()['arc_length'][-1]
  >>> f'Length is {length:.3f}'
  'Length is 0.812'
  
  This is identical to the geodesic_distance.
  
  >>> length = sphere.geodesic_distance(0, 100)
  >>> f'Length is {length:.3f}'
  'Length is 0.812'
  
  You can also plot the arc_length.
  
  >>> arc = path.compute_arc_length()
  >>> arc.plot(scalars="arc_length")
docstr_tok: ["Compute","the","arc","length","over","the","length","of","the","probed","line",".","It","adds","a","new","point-data","array","named","``","``","arc_length","''","``","with","the","computed","arc","length","for","each","of","the","polylines","in","the","input",".","For","all","other","cell","types",",","the","arc","length","is","set","to","0",".","Parameters","--","--","--","--","--","progress_bar",":","bool",",","default",":","False","Display","a","progress","bar","to","indicate","progress",".","Returns","--","--","--","-","float","Arc","length","of","the","length","of","the","probed","line",".","Examples","--","--","--","--",">",">",">","import","pyvista","as","pv",">",">",">","sphere","=","pv.Sphere","(",")",">",">",">","path","=","sphere.geodesic","(","0",",","100",")",">",">",">","length","=","path.compute_arc_length","(",")","[","'arc_length","'","]","[","-1","]",">",">",">","f'Length","is","{","length",":",".3f","}","'","'Length","is","0.812'","This","is","identical","to","the","geodesic_distance",".",">",">",">","length","=","sphere.geodesic_distance","(","0",",","100",")",">",">",">","f'Length","is","{","length",":",".3f","}","'","'Length","is","0.812'","You","can","also","plot","the","arc_length",".",">",">",">","arc","=","path.compute_arc_length","(",")",">",">",">","arc.plot","(","scalars=","''","arc_length","''",")"]
code: def compute_arc_length(self, progress_bar=False):
      """Compute the arc length over the length of the probed line.
  
      It adds a new point-data array named ``"arc_length"`` with the
      computed arc length for each of the polylines in the
      input. For all other cell types, the arc length is set to 0.
  
      Parameters
      ----------
      progress_bar : bool, default: False
          Display a progress bar to indicate progress.
  
      Returns
      -------
      float
          Arc length of the length of the probed line.
  
      Examples
      --------
      >>> import pyvista as pv
      >>> sphere = pv.Sphere()
      >>> path = sphere.geodesic(0, 100)
      >>> length = path.compute_arc_length()['arc_length'][-1]
      >>> f'Length is {length:.3f}'
      'Length is 0.812'
  
      This is identical to the geodesic_distance.
  
      >>> length = sphere.geodesic_distance(0, 100)
      >>> f'Length is {length:.3f}'
      'Length is 0.812'
  
      You can also plot the arc_length.
  
      >>> arc = path.compute_arc_length()
      >>> arc.plot(scalars="arc_length")
  
      """
      alg = _vtk.vtkAppendArcLength()
      alg.SetInputData(self)
      _update_alg(alg, progress_bar, "Computing the Arc Length")
      return _get_output(alg)
  
imports: import collections.abc
  import warnings
  import numpy
  import pyvista
  from pyvista.core import _vtk_core
  from pyvista.core.errors import MissingDataError, NotAllTrianglesError, PyVistaFutureWarning, VTKVersionError
  from pyvista.core.filters import _get_output, _update_alg
  from pyvista.core.filters.data_set import DataSetFilters
  from pyvista.core.utilities.arrays import FieldAssociation, get_array, get_array_association, set_default_active_scalars, vtk_id_list_to_array
  from pyvista.core.utilities.geometric_objects import NORMALS
  from pyvista.core.utilities.helpers import generate_plane, wrap
  from pyvista.core.utilities.misc import abstract_class, assert_empty_kwargs
label_desc: Use image node_id 34 for calling the PolyDataFilters obj's underlying member method code with example usage: obj.compute_arc_length(progress_bar) and returns: _get_output