Skip to content

Commit 01e9342

Browse files
c6585879713cf938e22458540a1d796c22a2decf
1 parent d8fbaba commit 01e9342

15 files changed

+14
-129
lines changed

docs/AnalysisReturn.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ Name | Type | Description | Notes
2222
**entities** | [**List[Entity]**](Entity.md) | | [optional]
2323
**order** | **int** | | [optional]
2424
**metadata** | **object** | | [optional]
25-
**point_count** | **int** | Number of point coordinates linked to this analysis. | [optional]
2625
**has_coordinates** | **bool** | | [optional]
2726
**has_images** | **bool** | | [optional]
2827
**has_z_maps** | **bool** | | [optional]

docs/PointBase.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**coordinates** | **List[Optional[float]]** | Location of the significant coordinate in three dimensional space. | [optional]
8+
**coordinates** | **List[float]** | Location of the significant coordinate in three dimensional space. | [optional]
99
**space** | **str** | Template space used to determine coordinate Examples include TAL or MNI. | [optional]
1010
**kind** | **str** | Method of how point was derived (e.g., center of mass) | [optional]
1111
**label_id** | **str** | If the point is associated with an image, this is the value the point takes in that image. | [optional]

docs/PointCommon.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ Name | Type | Description | Notes
99
**cluster_size** | **float** | size of the cluster in cubic millimeters | [optional]
1010
**subpeak** | **bool** | whether the reported peak is the max-peak statistic or a sub-maxmimal peak. | [optional]
1111
**deactivation** | **bool** | wheather the coordinate represents an decrease in activation relative to a baseline | [optional]
12-
**is_seed** | **bool** | whether the coordinate is marked as a seed location | [optional]
1312
**order** | **int** | determines the row to display the coordinate | [optional]
1413

1514
## Example

docs/PointRequest.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**coordinates** | **List[Optional[float]]** | Location of the significant coordinate in three dimensional space. | [optional]
8+
**coordinates** | **List[float]** | Location of the significant coordinate in three dimensional space. | [optional]
99
**space** | **str** | Template space used to determine coordinate Examples include TAL or MNI. | [optional]
1010
**kind** | **str** | Method of how point was derived (e.g., center of mass) | [optional]
1111
**label_id** | **str** | If the point is associated with an image, this is the value the point takes in that image. | [optional]
@@ -21,7 +21,6 @@ Name | Type | Description | Notes
2121
**cluster_size** | **float** | size of the cluster in cubic millimeters | [optional]
2222
**subpeak** | **bool** | whether the reported peak is the max-peak statistic or a sub-maxmimal peak. | [optional]
2323
**deactivation** | **bool** | wheather the coordinate represents an decrease in activation relative to a baseline | [optional]
24-
**is_seed** | **bool** | whether the coordinate is marked as a seed location | [optional]
2524
**order** | **int** | determines the row to display the coordinate | [optional]
2625

2726
## Example

docs/PointReturn.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Name | Type | Description | Notes
77
------------ | ------------- | ------------- | -------------
8-
**coordinates** | **List[Optional[float]]** | Location of the significant coordinate in three dimensional space. | [optional]
8+
**coordinates** | **List[float]** | Location of the significant coordinate in three dimensional space. | [optional]
99
**space** | **str** | Template space used to determine coordinate Examples include TAL or MNI. | [optional]
1010
**kind** | **str** | Method of how point was derived (e.g., center of mass) | [optional]
1111
**label_id** | **str** | If the point is associated with an image, this is the value the point takes in that image. | [optional]
@@ -25,7 +25,6 @@ Name | Type | Description | Notes
2525
**cluster_size** | **float** | size of the cluster in cubic millimeters | [optional]
2626
**subpeak** | **bool** | whether the reported peak is the max-peak statistic or a sub-maxmimal peak. | [optional]
2727
**deactivation** | **bool** | wheather the coordinate represents an decrease in activation relative to a baseline | [optional]
28-
**is_seed** | **bool** | whether the coordinate is marked as a seed location | [optional]
2928
**order** | **int** | determines the row to display the coordinate | [optional]
3029

3130
## Example

docs/StoreApi.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3156,7 +3156,7 @@ void (empty response body)
31563156
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
31573157

31583158
# **studysets_id_get**
3159-
> StudysetReturn studysets_id_get(id, nested=nested, summary=summary, gzip=gzip)
3159+
> StudysetReturn studysets_id_get(id, nested=nested, gzip=gzip)
31603160
31613161
GET a studyset
31623162

@@ -3184,12 +3184,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
31843184
api_instance = neurostore_sdk.StoreApi(api_client)
31853185
id = 'id_example' # str |
31863186
nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
3187-
summary = True # bool | return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested (optional)
31883187
gzip = True # bool | return the content as gzipped content (optional)
31893188

31903189
try:
31913190
# GET a studyset
3192-
api_response = api_instance.studysets_id_get(id, nested=nested, summary=summary, gzip=gzip)
3191+
api_response = api_instance.studysets_id_get(id, nested=nested, gzip=gzip)
31933192
print("The response of StoreApi->studysets_id_get:\n")
31943193
pprint(api_response)
31953194
except Exception as e:
@@ -3205,7 +3204,6 @@ Name | Type | Description | Notes
32053204
------------- | ------------- | ------------- | -------------
32063205
**id** | **str**| |
32073206
**nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional]
3208-
**summary** | **bool**| return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested | [optional]
32093207
**gzip** | **bool**| return the content as gzipped content | [optional]
32103208

32113209
### Return type

docs/StudysetsApi.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ void (empty response body)
191191
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
192192

193193
# **studysets_id_get**
194-
> StudysetReturn studysets_id_get(id, nested=nested, summary=summary, gzip=gzip)
194+
> StudysetReturn studysets_id_get(id, nested=nested, gzip=gzip)
195195
196196
GET a studyset
197197

@@ -219,12 +219,11 @@ with neurostore_sdk.ApiClient(configuration) as api_client:
219219
api_instance = neurostore_sdk.StudysetsApi(api_client)
220220
id = 'id_example' # str |
221221
nested = True # bool | whether to show the URI to a resource (false) or to embed the object in the response (true) (optional)
222-
summary = True # bool | return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested (optional)
223222
gzip = True # bool | return the content as gzipped content (optional)
224223

225224
try:
226225
# GET a studyset
227-
api_response = api_instance.studysets_id_get(id, nested=nested, summary=summary, gzip=gzip)
226+
api_response = api_instance.studysets_id_get(id, nested=nested, gzip=gzip)
228227
print("The response of StudysetsApi->studysets_id_get:\n")
229228
pprint(api_response)
230229
except Exception as e:
@@ -240,7 +239,6 @@ Name | Type | Description | Notes
240239
------------- | ------------- | ------------- | -------------
241240
**id** | **str**| |
242241
**nested** | **bool**| whether to show the URI to a resource (false) or to embed the object in the response (true) | [optional]
243-
**summary** | **bool**| return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested | [optional]
244242
**gzip** | **bool**| return the content as gzipped content | [optional]
245243

246244
### Return type

neurostore_sdk/api/store_api.py

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12081,7 +12081,6 @@ def studysets_id_get(
1208112081
self,
1208212082
id: StrictStr,
1208312083
nested: Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None,
12084-
summary: Annotated[Optional[StrictBool], Field(description="return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested")] = None,
1208512084
gzip: Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None,
1208612085
_request_timeout: Union[
1208712086
None,
@@ -12104,8 +12103,6 @@ def studysets_id_get(
1210412103
:type id: str
1210512104
:param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
1210612105
:type nested: bool
12107-
:param summary: return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested
12108-
:type summary: bool
1210912106
:param gzip: return the content as gzipped content
1211012107
:type gzip: bool
1211112108
:param _request_timeout: timeout setting for this request. If one
@@ -12133,7 +12130,6 @@ def studysets_id_get(
1213312130
_param = self._studysets_id_get_serialize(
1213412131
id=id,
1213512132
nested=nested,
12136-
summary=summary,
1213712133
gzip=gzip,
1213812134
_request_auth=_request_auth,
1213912135
_content_type=_content_type,
@@ -12161,7 +12157,6 @@ def studysets_id_get_with_http_info(
1216112157
self,
1216212158
id: StrictStr,
1216312159
nested: Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None,
12164-
summary: Annotated[Optional[StrictBool], Field(description="return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested")] = None,
1216512160
gzip: Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None,
1216612161
_request_timeout: Union[
1216712162
None,
@@ -12184,8 +12179,6 @@ def studysets_id_get_with_http_info(
1218412179
:type id: str
1218512180
:param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
1218612181
:type nested: bool
12187-
:param summary: return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested
12188-
:type summary: bool
1218912182
:param gzip: return the content as gzipped content
1219012183
:type gzip: bool
1219112184
:param _request_timeout: timeout setting for this request. If one
@@ -12213,7 +12206,6 @@ def studysets_id_get_with_http_info(
1221312206
_param = self._studysets_id_get_serialize(
1221412207
id=id,
1221512208
nested=nested,
12216-
summary=summary,
1221712209
gzip=gzip,
1221812210
_request_auth=_request_auth,
1221912211
_content_type=_content_type,
@@ -12241,7 +12233,6 @@ def studysets_id_get_without_preload_content(
1224112233
self,
1224212234
id: StrictStr,
1224312235
nested: Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None,
12244-
summary: Annotated[Optional[StrictBool], Field(description="return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested")] = None,
1224512236
gzip: Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None,
1224612237
_request_timeout: Union[
1224712238
None,
@@ -12264,8 +12255,6 @@ def studysets_id_get_without_preload_content(
1226412255
:type id: str
1226512256
:param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
1226612257
:type nested: bool
12267-
:param summary: return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested
12268-
:type summary: bool
1226912258
:param gzip: return the content as gzipped content
1227012259
:type gzip: bool
1227112260
:param _request_timeout: timeout setting for this request. If one
@@ -12293,7 +12282,6 @@ def studysets_id_get_without_preload_content(
1229312282
_param = self._studysets_id_get_serialize(
1229412283
id=id,
1229512284
nested=nested,
12296-
summary=summary,
1229712285
gzip=gzip,
1229812286
_request_auth=_request_auth,
1229912287
_content_type=_content_type,
@@ -12316,7 +12304,6 @@ def _studysets_id_get_serialize(
1231612304
self,
1231712305
id,
1231812306
nested,
12319-
summary,
1232012307
gzip,
1232112308
_request_auth,
1232212309
_content_type,
@@ -12346,10 +12333,6 @@ def _studysets_id_get_serialize(
1234612333

1234712334
_query_params.append(('nested', nested))
1234812335

12349-
if summary is not None:
12350-
12351-
_query_params.append(('summary', summary))
12352-
1235312336
if gzip is not None:
1235412337

1235512338
_query_params.append(('gzip', gzip))

neurostore_sdk/api/studysets_api.py

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -785,7 +785,6 @@ def studysets_id_get(
785785
self,
786786
id: StrictStr,
787787
nested: Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None,
788-
summary: Annotated[Optional[StrictBool], Field(description="return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested")] = None,
789788
gzip: Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None,
790789
_request_timeout: Union[
791790
None,
@@ -808,8 +807,6 @@ def studysets_id_get(
808807
:type id: str
809808
:param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
810809
:type nested: bool
811-
:param summary: return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested
812-
:type summary: bool
813810
:param gzip: return the content as gzipped content
814811
:type gzip: bool
815812
:param _request_timeout: timeout setting for this request. If one
@@ -837,7 +834,6 @@ def studysets_id_get(
837834
_param = self._studysets_id_get_serialize(
838835
id=id,
839836
nested=nested,
840-
summary=summary,
841837
gzip=gzip,
842838
_request_auth=_request_auth,
843839
_content_type=_content_type,
@@ -865,7 +861,6 @@ def studysets_id_get_with_http_info(
865861
self,
866862
id: StrictStr,
867863
nested: Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None,
868-
summary: Annotated[Optional[StrictBool], Field(description="return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested")] = None,
869864
gzip: Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None,
870865
_request_timeout: Union[
871866
None,
@@ -888,8 +883,6 @@ def studysets_id_get_with_http_info(
888883
:type id: str
889884
:param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
890885
:type nested: bool
891-
:param summary: return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested
892-
:type summary: bool
893886
:param gzip: return the content as gzipped content
894887
:type gzip: bool
895888
:param _request_timeout: timeout setting for this request. If one
@@ -917,7 +910,6 @@ def studysets_id_get_with_http_info(
917910
_param = self._studysets_id_get_serialize(
918911
id=id,
919912
nested=nested,
920-
summary=summary,
921913
gzip=gzip,
922914
_request_auth=_request_auth,
923915
_content_type=_content_type,
@@ -945,7 +937,6 @@ def studysets_id_get_without_preload_content(
945937
self,
946938
id: StrictStr,
947939
nested: Annotated[Optional[StrictBool], Field(description="whether to show the URI to a resource (false) or to embed the object in the response (true)")] = None,
948-
summary: Annotated[Optional[StrictBool], Field(description="return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested")] = None,
949940
gzip: Annotated[Optional[StrictBool], Field(description="return the content as gzipped content")] = None,
950941
_request_timeout: Union[
951942
None,
@@ -968,8 +959,6 @@ def studysets_id_get_without_preload_content(
968959
:type id: str
969960
:param nested: whether to show the URI to a resource (false) or to embed the object in the response (true)
970961
:type nested: bool
971-
:param summary: return a lightweight summary payload with study metadata and per-analysis coordinate counts; incompatible with nested
972-
:type summary: bool
973962
:param gzip: return the content as gzipped content
974963
:type gzip: bool
975964
:param _request_timeout: timeout setting for this request. If one
@@ -997,7 +986,6 @@ def studysets_id_get_without_preload_content(
997986
_param = self._studysets_id_get_serialize(
998987
id=id,
999988
nested=nested,
1000-
summary=summary,
1001989
gzip=gzip,
1002990
_request_auth=_request_auth,
1003991
_content_type=_content_type,
@@ -1020,7 +1008,6 @@ def _studysets_id_get_serialize(
10201008
self,
10211009
id,
10221010
nested,
1023-
summary,
10241011
gzip,
10251012
_request_auth,
10261013
_content_type,
@@ -1050,10 +1037,6 @@ def _studysets_id_get_serialize(
10501037

10511038
_query_params.append(('nested', nested))
10521039

1053-
if summary is not None:
1054-
1055-
_query_params.append(('summary', summary))
1056-
10571040
if gzip is not None:
10581041

10591042
_query_params.append(('gzip', gzip))

neurostore_sdk/models/analysis_return.py

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,12 @@ class AnalysisReturn(BaseModel):
5050
entities: Optional[List[Entity]] = None
5151
order: Optional[StrictInt] = None
5252
metadata: Optional[Dict[str, Any]] = None
53-
point_count: Optional[StrictInt] = Field(default=None, description="Number of point coordinates linked to this analysis.")
5453
has_coordinates: Optional[StrictBool] = None
5554
has_images: Optional[StrictBool] = None
5655
has_z_maps: Optional[StrictBool] = None
5756
has_t_maps: Optional[StrictBool] = None
5857
has_beta_and_variance_maps: Optional[StrictBool] = None
59-
__properties: ClassVar[List[str]] = ["name", "description", "weights", "created_at", "updated_at", "id", "public", "user", "username", "study", "images", "points", "conditions", "table_id", "entities", "order", "metadata", "point_count", "has_coordinates", "has_images", "has_z_maps", "has_t_maps", "has_beta_and_variance_maps"]
58+
__properties: ClassVar[List[str]] = ["name", "description", "weights", "created_at", "updated_at", "id", "public", "user", "username", "study", "images", "points", "conditions", "table_id", "entities", "order", "metadata", "has_coordinates", "has_images", "has_z_maps", "has_t_maps", "has_beta_and_variance_maps"]
6059

6160
model_config = ConfigDict(
6261
populate_by_name=True,
@@ -159,11 +158,6 @@ def to_dict(self) -> Dict[str, Any]:
159158
if self.metadata is None and "metadata" in self.model_fields_set:
160159
_dict['metadata'] = None
161160

162-
# set to None if point_count (nullable) is None
163-
# and model_fields_set contains the field
164-
if self.point_count is None and "point_count" in self.model_fields_set:
165-
_dict['point_count'] = None
166-
167161
return _dict
168162

169163
@classmethod
@@ -193,7 +187,6 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
193187
"entities": [Entity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None,
194188
"order": obj.get("order"),
195189
"metadata": obj.get("metadata"),
196-
"point_count": obj.get("point_count"),
197190
"has_coordinates": obj.get("has_coordinates"),
198191
"has_images": obj.get("has_images"),
199192
"has_z_maps": obj.get("has_z_maps"),

0 commit comments

Comments
 (0)