gvf_inclined_circle.py API 参考¶

圆柱面与倾斜平面交线的三维导航向量场。

• 源码路径：single_demo/scripts/gvf_lib/gvf_inclined_circle.py
• 本页函数/方法数：13
• 行号对应本文档生成时采用的源码版本；源码调整后应重新生成本页。

Cylinder.__init__¶

__init__(self, center=[0, 0, 0], r=50.0, ori=2, k=[0.1, 0.1, 0.1])

• 源码位置：第 7 行
• 类别：初始化
• 作用：初始化 Cylinder 的参数、状态缓存以及所需的通信或算法对象。
• 主要调用：float, np.array
• 写入状态：self.center, self.circle_index, self.dimension, self.k, self.ori, self.r

Cylinder.GetPhi¶

GetPhi(self, pos)

• 源码位置：第 22 行
• 类别：算法查询/计算
• 作用：计算当前位置相对隐式曲面或参数轨迹的约束误差。
• 主要调用：np.array, np.linalg.norm
• 写入状态：不直接写入对象属性

Cylinder.GetJacobin¶

GetJacobin(self, pos)

• 源码位置：第 30 行
• 类别：算法查询/计算
• 作用：计算隐式曲面约束对空间位置的雅可比向量。
• 主要调用：np.array, np.linalg.norm, np.zeros
• 写入状态：self.circle_index

InclinePlane.__init__¶

__init__(self, normal_vector=[1.0, 1.0, 5.0], point=[0.0, 0.0, 100.0], k=[0.1, 0.1, 0.1])

• 源码位置：第 42 行
• 类别：初始化
• 作用：初始化 InclinePlane 的参数、状态缓存以及所需的通信或算法对象。
• 主要调用：np.array, self.CalFunction
• 写入状态：self.k, self.n, self.point

InclinePlane.CalFunction¶

CalFunction(self)

• 源码位置：第 49 行
• 类别：内部计算/辅助
• 作用：源码内部辅助函数；结合签名、状态写入和主要调用可定位其在调用链中的职责。
• 主要调用：np.append, np.copy
• 写入状态：self.coefficient

InclinePlane.GetPhi¶

GetPhi(self, pos)

• 源码位置：第 56 行
• 类别：算法查询/计算
• 作用：计算当前位置相对隐式曲面或参数轨迹的约束误差。
• 主要调用：np.array
• 写入状态：self.phi

InclinePlane.GetJacobin¶

GetJacobin(self, pos)

• 源码位置：第 61 行
• 类别：算法查询/计算
• 作用：计算隐式曲面约束对空间位置的雅可比向量。
• 主要调用：np.array
• 写入状态：不直接写入对象属性

GVF.__init__¶

__init__(self, surfaces)

• 源码位置：第 68 行
• 类别：初始化
• 作用：初始化 GVF 的参数、状态缓存以及所需的通信或算法对象。
• 主要调用：np.vstack
• 写入状态：self.k, self.surfaces

GVF.GetPhi¶

GetPhi(self, pos)

• 源码位置：第 72 行
• 类别：算法查询/计算
• 作用：计算当前位置相对隐式曲面或参数轨迹的约束误差。
• 主要调用：GetPhi
• 写入状态：self.phi_1, self.phi_2

GVF.GetJacobin¶

GetJacobin(self, pos)

• 源码位置：第 77 行
• 类别：算法查询/计算
• 作用：计算隐式曲面约束对空间位置的雅可比向量。
• 主要调用：GetJacobin
• 写入状态：self.jac_1, self.jac_2

GVF.GetNormalV¶

GetNormalV(self, pos)

• 源码位置：第 82 行
• 类别：算法查询/计算
• 作用：计算并返回名称所指的轨迹、误差或几何量。具体定义见本页所属模块说明。
• 主要调用：print, self.GetJacobin, self.GetPhi
• 写入状态：self.vn

GVF.GetTangentV¶

GetTangentV(self, pos)

• 源码位置：第 91 行
• 类别：算法查询/计算
• 作用：计算并返回名称所指的轨迹、误差或几何量。具体定义见本页所属模块说明。
• 主要调用：np.cross, self.GetJacobin
• 写入状态：self.vt

GVF.GetGuideV¶

GetGuideV(self, pos)

• 源码位置：第 96 行
• 类别：算法查询/计算
• 作用：叠加曲线切向项与曲面误差收敛项，并归一化得到三维导航方向。
• 主要调用：np.linalg.norm, self.GetNormalV, self.GetTangentV
• 写入状态：self.vg