pancake.lead.Segment Class Reference

Public Member Functions
	__init__ (self, float length, float tau=0.0, float kappa_g=0.0, float kappa_n=0.0, float ramp=0.0, str shape="plateau", str name="segment")
	profile (self, float x)
bool	is_constant (self, float x0, float x1)
np.ndarray	omega (self, float x)
np.ndarray	domega (self, float x)
float	effective_length (self)
np.ndarray	total_rotation (self)
	__repr__ (self)

Public Attributes
	length = float(length)
float	ramp = float(ramp)
str	shape = shape
	amplitude = np.array([tau, kappa_g, kappa_n], dtype=float)
	name = name
	knots = np.unique(np.clip(np.array(knots), 0.0, self.length))

Detailed Description

Strip section of given length with curvature amplitudes times a profile.

Constructor & Destructor Documentation

__init__()

pancake.lead.Segment.__init__	(		self,
		float	length,
		float	tau = 0.0,
		float	kappa_g = 0.0,
		float	kappa_n = 0.0,
		float	ramp = 0.0,
		str	shape = "plateau",
		str	name = "segment" )

Member Function Documentation

__repr__()

pancake.lead.Segment.__repr__

(

self

)

domega()

np.ndarray pancake.lead.Segment.domega	(		self,
		float	x )

effective_length()

float pancake.lead.Segment.effective_length

(

self

)

Integral of the profile: the length that contributes to the total rotation.

is_constant()

bool pancake.lead.Segment.is_constant	(		self,
		float	x0,
		float	x1 )

True if the profile is constant (== 1) on [x0, x1].

omega()

np.ndarray pancake.lead.Segment.omega	(		self,
		float	x )

profile()

pancake.lead.Segment.profile	(		self,
		float	x )

Profile P(x) and dP/dx.

total_rotation()

np.ndarray pancake.lead.Segment.total_rotation

(

self

)

Integrated (tau, kappa_g, kappa_n) in radians.

Member Data Documentation

amplitude

pancake.lead.Segment.amplitude = np.array([tau, kappa_g, kappa_n], dtype=float)

knots

pancake.lead.Segment.knots = np.unique(np.clip(np.array(knots), 0.0, self.length))

length

pancake.lead.Segment.length = float(length)

name

pancake.lead.Segment.name = name

ramp

pancake.lead.Segment.ramp = float(ramp)

shape

pancake.lead.Segment.shape = shape

---

The documentation for this class was generated from the following file:

• examples/pancake/python/pancake/lead.py