Reference

Practical step-by-step guides for the more experienced user.

Reference

• API
  • scanspec
  • scanspec.__version__
  • scanspec.core
    • alternative_constructor()
    • as_tagged_union()
    • if_instance_do()
    • Axis
    • AxesPoints
    • Frames
      • Frames.midpoints
      • Frames.lower
      • Frames.upper
      • Frames.gap
      • Frames.axes()
      • Frames.extract()
      • Frames.concat()
      • Frames.zip()
    • SnakedFrames
      • SnakedFrames.from_frames()
      • SnakedFrames.extract()
    • gap_between_frames()
    • squash_frames()
    • Path
      • Path.stack
      • Path.index
      • Path.lengths
      • Path.end_index
      • Path.consume()
    • Midpoints
      • Midpoints.stack
      • Midpoints.axes
  • scanspec.specs
    • DURATION
    • Spec
      • Spec.axes()
      • Spec.calculate()
      • Spec.frames()
      • Spec.midpoints()
      • Spec.zip()
      • Spec.concat()
      • Spec.serialize()
      • Spec.deserialize()
      • Spec.to_gql_input()
    • Product
    • Repeat
    • Zip
    • Mask
    • Snake
    • Concat
    • Squash
    • Line
      • Line.bounded()
    • Static
      • Static.duration()
    • Spiral
      • Spiral.spaced()
    • fly()
    • step()
  • scanspec.regions
    • Region
      • Region.axis_sets()
      • Region.mask()
    • get_mask()
    • CombinationOf
    • UnionOf
    • IntersectionOf
    • DifferenceOf
    • SymmetricDifferenceOf
    • Range
    • Rectangle
    • Polygon
    • Circle
    • Ellipse
    • find_regions()
  • scanspec.plot
    • plot_spec()
  • scanspec.service
    • Points
      • Points.string()
      • Points.float_list()
      • Points.b64()
    • AxisFrames
      • AxisFrames.smallest_step()
    • PointsResponse
      • PointsResponse.total_frames
      • PointsResponse.returned_frames
      • PointsResponse.axes()
      • PointsResponse.smallest_abs_step()
    • validate_spec()
    • get_points()
    • reduce_frames()
    • sub_sample()
    • scanspec_schema_text()
    • run_app()
• Contributing to the project
  • Issue or Discussion?
  • Code coverage
  • Developer guide
• Releases
• Index