playbook/skills/tsl-api-reference/references/codegen/module/ts-seq-factor-performance.md

量化择时 / 时序因子

TSSeqFactorPerformance

声明：class

时序因子分析框架

fData

声明：field

因子时间序列数据 必需设置 空数组

可见性：public

类型：table

fIndexID

声明：field

基准指数代码 SH000300（沪深 300）

可见性：public

类型：string

set_Factor_Group()

声明：function

对因子值进行分类，若因子数据已有分类字段，则无需设置该方法，否则需要重写，重写要

可见性：public

返回：table

set_Index_Data()

声明：function

获取基准时序数据，可重写，重写要求：必须包含以下字段

可见性：public

返回：table

set_StockZF(begt, endt, stockid)

声明：function

获取指定券（基准）区间涨幅数据，用来衡量基准在过去或未来一段时间的累计收益，为收

可见性：public

参数	类型	说明
begt	datetime	日期型，区间开始日
endt	datetime	日期型，区间截止日
stockid	string	String，证券代码

返回：table

get_Factor_Histogram(bins, format)

声明：function

对全区间的因子值进行频数分布

可见性：public

参数	类型	说明
bins	array	如果为整数，则表示频数分组的组数，如果是数组，则表示分割的上下界（如设置为 array(-1,0,1)，则分组为两组，标签为：-10,01）；除第 1 组（最小的）为左右均闭，其余组为 左开右闭；
format	string	String，格式化字符串，显示分组标签用；如因子值精度为 0.01，则可设置为"0.00"，如 果设置为"0.0"，则可能存在无法分辨分组中最小值、最大值

返回：table

get_Index_Detail()

声明：function

获取时序因子与基准走势对照数据，若需使用自有基准数据，请重写 Set_Index_Data()

可见性：public

返回：table

get_Corr_All(m, op)

声明：function

获取全区间因子值与基准走势的移动相关系数，支持设置基准领先滞后期数和基准数据类型

可见性：public

参数	类型	说明
m	integer	Int，基准领先滞后期数 取值 含义 备注 0 计算相关系数，因子与基准所用数据同步 默认 正整数 基准所用数据向后推移 abs(moveN)期
op	integer	Int，计算相关系数，基准所用数据类型 取值 含义 备注 0 基准采用价格数据计算相关系数 默认 1 基准采用涨幅数据计算相关系数 2 基准采用对数价格数据计算相关系数 3 基准采用对数涨幅数据计算相关系数

返回：real

get_Corr_Detail(n, m, op)

声明：function

获取全区间因子值与基准走势的移动相关系数详情；窗口长度不足 N 时不计算

可见性：public

参数	类型	说明
n	integer	Int，窗口期数，为正整数，默认 30 期
m	integer	Int，基准领先滞后期数 取值 含义 备注 0 计算相关系数，因子与基准所用数据同步 默认 正整数 基准所用数据向后推移 abs(moveN)期 负整数 基准所用数据向前推移 abs(moveN)期
op	integer	Int，计算相关系数，基准所用数据类型 取值 含义 备注 0 基准采用价格数据计算相关系数 默认 1 基准采用涨幅数据计算相关系数 2 基准采用对数价格数据计算相关系数 3 基准采用对数涨幅数据计算相关系数

返回：table

get_Corr_Histogram(n, m, op)

声明：function

对全区间的相关系数进行频数分布，相关系数计算同 Get_Corr_Detail

可见性：public

参数	类型	说明
n	integer	Int，窗口期数，为正整数，默认 30 期
m	integer	Int，基准领先滞后期数 取值 含义 备注 0 计算相关系数，因子与基准所用数据同步 默认 正整数 基准所用数据向后推移 abs(moveN)期 负整数 基准所用数据向前推移 abs(moveN)期
op	integer	Int，计算相关系数，基准所用数据类型 取值 含义 备注 0 基准采用价格数据计算相关系数 默认 1 基准采用涨幅数据计算相关系数 2 基准采用对数价格数据计算相关系数 3 基准采用对数涨幅数据计算相关系数

返回：table

get_LagReturn_Detail(n, cy)

声明：function

获取未来收益推移涨幅详情；累计涨幅计算说明：

可见性：public

参数	类型	说明
n	integer	Int，计算未来涨幅期数，为正整数
cy	string	String，推移涨幅所用周期，默认日线

返回：table

get_LagReturn_Stat(n, cy)

声明：function

获取未来收益分组统计

可见性：public

参数	类型	说明
n	array	Int，计算未来涨幅期数，为正整数或 一维数组（支持多个）
cy	string	String，推移涨幅所用周期，默认日线

返回：table

get_LagReturn_Matrix(n_arr, cy)

声明：function

时机持有分析

可见性：public

参数	类型	说明
n_arr	array	Array，向后推移期数数组，为正整数数组
cy	string	String，推移涨幅所用周期，默认日线

返回：table

get_LeadLagReturn_Detail(n, cy)

声明：function

获取前后推移 N 日累计涨幅详情；累计涨幅计算说明：

可见性：public

参数	类型	说明
n	integer	Int，计算未来涨幅期数，为正整数
cy	string	String，推移涨幅所用周期，默认日线

返回：table

get_LeadLagReturn_Stat(n, cy)

声明：function

获取前后收益分组统计

可见性：public

参数	类型	说明
n	integer	Int，计算前移、后移涨幅期数，为正整数
cy	string	String，推移涨幅所用周期，默认日线

返回：table

get_IC_All(n, cy, m, ic_type)

声明：function

获取全区间因子值与基准未来 N 期累计涨幅之间的 IC，支持领先滞后与 IC 类型设置

可见性：public

参数	类型	说明
n	array	Int，计算未来涨幅的期数，为正整数 或 一维数组（支持多个）
cy	string	String，推移涨幅所用周期，默认日线
m	array	Int，基准领先滞后期数，为整数 或 一维数组（支持多个） 取值 含义 备注 0 计算相关系数，因子与基准所用数据同步 默认 正整数 基准所用数据向后推移 abs(M)期 负整数 基准所用数据向前推移 abs(M)期
ic_type	integer	Int, IC 类型——0: normIC（默认），1：rankIC

返回：table

get_IC_Roll(k, n, cy, m, ic_type)

声明：function

按 K 期滚动窗口获取因子值与基准未来 N 期累计涨幅之间的 IC 序列

可见性：public

参数	类型	说明
k	array	int，滚动窗口长度，为正整数 或 一维数组（支持多个）
n	array	Int，计算未来涨幅的期数，为正整数 或 一维数组（支持多个）
cy	string	String，推移涨幅所用周期，默认日线
m	array	Int，基准领先滞后期数，为整数 或 一维数组（支持多个） 取值 含义 备注 0 计算相关系数，因子与基准所用数据同步 默认 正整数 基准所用数据向后推移 abs(M)期 负整数 基准所用数据向前推移 abs(M)期
ic_type	integer	Int, IC 类型——0: normIC（默认），1：rankIC

返回：table

get_Factor_Report_plot()

声明：function

获取因子走势报告（因子与基准走势对照，时序IC 走势），需先执行时序 ICGet_IC_Roll

可见性：public

返回：table